@lgriffin/esi.ts 2.0.0 → 5.0.0

package/package.json

@@ -1,70 +1,181 @@
-{
-  "name": "@lgriffin/esi.ts",
-  "version": "2.0.0",
-  "description": "This is a TypeScript Implementation for the EVE Online API offered through ESI",
-  "main": "index.js",
-  "type": "commonjs",
-  "scripts": {
-    "build": "tsc",
-    "start": "node dist/index.js",
-    "dev": "ts-node demo/examples.ts",
-    "example": "ts-node src/index.ts",
-    "examples:flexible": "ts-node demo/flexible-examples.ts",
-    "lint": "eslint src --ext .ts",
-    "lint:fix": "eslint src --ext .ts --fix",
-    "test": "jest --config jest.unit.config.cjs",
-    "test:watch": "jest --config jest.unit.config.cjs --watch",
-    "test:improved": "jest --config jest.unit.config.cjs --testPathPattern=improved",
-    "bdd": "jest --config jest.unit.config.cjs --testPathPattern=bdd-",
-    "bdd:alliance": "jest --config jest.unit.config.cjs --testPathPattern=bdd-alliance",
-    "bdd:character": "jest --config jest.unit.config.cjs --testPathPattern=bdd-character",
-    "bdd:corporation": "jest --config jest.unit.config.cjs --testPathPattern=bdd-corporation",
-    "bdd:market": "jest --config jest.unit.config.cjs --testPathPattern=bdd-market",
-    "bdd:universe": "jest --config jest.unit.config.cjs --testPathPattern=bdd-universe",
-    "bdd:integration": "jest --config jest.unit.config.cjs --testPathPattern=bdd-integration",
-    "bdd:performance": "jest --config jest.unit.config.cjs --testPathPattern=bdd-performance",
-    "coverage": "jest --config jest.unit.config.cjs --coverage",
-    "test:all": "npm run test && npm run test:improved && npm run bdd",
-    "docs": "typedoc --options typedoc.json",
-    "docs:watch": "typedoc --options typedoc.json --watch",
-    "docs:serve": "npx http-server docs -p 8080 -o",
-    "clean": "rimraf dist coverage docs",
-    "clean:docs": "rimraf docs",
-    "prepare": "npm run build",
-    "health-check": "ts-node -e \"import('./src/EsiClient').then(({EsiClient}) => new EsiClient().healthCheck().then(console.log))\""
-  },
-  "keywords": [],
-  "author": "lgriffin",
-  "license": "GPL-3.0-or-later",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/lgriffin/ESI.ts"
-  },
-  "devDependencies": {
-    "@types/chai": "^4.3.20",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.19.17",
-    "@types/winston": "^2.4.4",
-    "@types/winston-loggly-bulk": "^3.0.6",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "chai": "^5.3.3",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "jest": "^29.7.0",
-    "jest-fetch-mock": "^3.0.3",
-    "jest-junit": "^16.0.0",
-    "prettier": "^3.3.2",
-    "ts-jest": "^29.2.2",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.26.10",
-    "typescript": "^5.9.2"
-  },
-  "dependencies": {
-    "axios": "^1.7.2",
-    "winston": "^3.13.0",
-    "winston-loggly-bulk": "^3.2.1",
-    "winston-transport": "^4.7.0"
-  }
-}
+{
+  "name": "@lgriffin/esi.ts",
+  "version": "5.0.0",
+  "description": "This is a TypeScript Implementation for the EVE Online API offered through ESI",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "ts-node examples/character-profile.ts",
+    "example": "ts-node examples/character-profile.ts",
+    "example:status": "ts-node examples/status.ts",
+    "example:character": "ts-node examples/character-lookup.ts",
+    "example:universe": "ts-node examples/universe-info.ts",
+    "example:market": "ts-node examples/market-prices.ts",
+    "example:alliance": "ts-node examples/alliance-info.ts",
+    "example:route": "ts-node examples/route-planner.ts",
+    "example:wars": "ts-node examples/wars.ts",
+    "example:sovereignty": "ts-node examples/sovereignty.ts",
+    "example:skyhooks": "ts-node examples/skyhooks.ts",
+    "example:mercenary": "ts-node examples/mercenary.ts",
+    "example:access-lists": "ts-node examples/access-lists.ts",
+    "example:industry": "ts-node examples/industry.ts",
+    "example:incursions": "ts-node examples/incursions.ts",
+    "example:dogma": "ts-node examples/dogma.ts",
+    "example:wallet": "ts-node examples/wallet-overview.ts",
+    "example:skills": "ts-node examples/skills-overview.ts",
+    "example:assets": "ts-node examples/assets-inventory.ts",
+    "example:contracts": "ts-node examples/contracts-browser.ts",
+    "example:killmails": "ts-node examples/killmails.ts",
+    "example:fleet": "ts-node examples/fleet-operations.ts",
+    "example:mail": "ts-node examples/mail-inbox.ts",
+    "example:location": "ts-node examples/location-tracker.ts",
+    "example:fittings": "ts-node examples/fittings-clones.ts",
+    "example:contacts": "ts-node examples/contacts.ts",
+    "example:rate-limiting": "ts-node examples/rate-limiting.ts",
+    "example:cursor-pagination": "ts-node examples/cursor-pagination.ts",
+    "example:token-refresh": "ts-node examples/token-refresh.ts",
+    "token:create": "ts-node scripts/create-token.ts",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "test": "jest --config jest.unit.config.cjs",
+    "test:watch": "jest --config jest.unit.config.cjs --watch",
+    "bdd": "jest --config jest.unit.config.cjs --testPathPattern=bdd-",
+    "bdd:alliance": "jest --config jest.unit.config.cjs --testPathPattern=bdd-alliance",
+    "bdd:assets": "jest --config jest.unit.config.cjs --testPathPattern=bdd-assets",
+    "bdd:calendar": "jest --config jest.unit.config.cjs --testPathPattern=bdd-calendar",
+    "bdd:character": "jest --config jest.unit.config.cjs --testPathPattern=bdd-character",
+    "bdd:clones": "jest --config jest.unit.config.cjs --testPathPattern=bdd-clones",
+    "bdd:contacts": "jest --config jest.unit.config.cjs --testPathPattern=bdd-contacts",
+    "bdd:contracts": "jest --config jest.unit.config.cjs --testPathPattern=bdd-contracts",
+    "bdd:corporation": "jest --config jest.unit.config.cjs --testPathPattern=bdd-corporation",
+    "bdd:dogma": "jest --config jest.unit.config.cjs --testPathPattern=bdd-dogma",
+    "bdd:etag-caching": "jest --config jest.unit.config.cjs --testPathPattern=bdd-etag-caching",
+    "bdd:factions": "jest --config jest.unit.config.cjs --testPathPattern=bdd-factions",
+    "bdd:fittings": "jest --config jest.unit.config.cjs --testPathPattern=bdd-fittings",
+    "bdd:fleets": "jest --config jest.unit.config.cjs --testPathPattern=bdd-fleets",
+    "bdd:freelance": "jest --config jest.unit.config.cjs --testPathPattern=bdd-freelance",
+    "bdd:incursions": "jest --config jest.unit.config.cjs --testPathPattern=bdd-incursions",
+    "bdd:industry": "jest --config jest.unit.config.cjs --testPathPattern=bdd-industry",
+    "bdd:insurance": "jest --config jest.unit.config.cjs --testPathPattern=bdd-insurance",
+    "bdd:killmails": "jest --config jest.unit.config.cjs --testPathPattern=bdd-killmails",
+    "bdd:location": "jest --config jest.unit.config.cjs --testPathPattern=bdd-location",
+    "bdd:loyalty": "jest --config jest.unit.config.cjs --testPathPattern=bdd-loyalty",
+    "bdd:mail": "jest --config jest.unit.config.cjs --testPathPattern=bdd-mail",
+    "bdd:market": "jest --config jest.unit.config.cjs --testPathPattern=bdd-market",
+    "bdd:meta": "jest --config jest.unit.config.cjs --testPathPattern=bdd-meta",
+    "bdd:pi": "jest --config jest.unit.config.cjs --testPathPattern=bdd-pi",
+    "bdd:route": "jest --config jest.unit.config.cjs --testPathPattern=bdd-route",
+    "bdd:search": "jest --config jest.unit.config.cjs --testPathPattern=bdd-search",
+    "bdd:skills": "jest --config jest.unit.config.cjs --testPathPattern=bdd-skills",
+    "bdd:skyhooks": "jest --config jest.unit.config.cjs --testPathPattern=bdd-skyhooks",
+    "bdd:sovereignty": "jest --config jest.unit.config.cjs --testPathPattern=bdd-sovereignty",
+    "bdd:mercenary": "jest --config jest.unit.config.cjs --testPathPattern=bdd-mercenary",
+    "bdd:access-lists": "jest --config jest.unit.config.cjs --testPathPattern=bdd-access-lists",
+    "bdd:status": "jest --config jest.unit.config.cjs --testPathPattern=bdd-status",
+    "bdd:ui": "jest --config jest.unit.config.cjs --testPathPattern=bdd-ui",
+    "bdd:universe": "jest --config jest.unit.config.cjs --testPathPattern=bdd-universe",
+    "bdd:wallet": "jest --config jest.unit.config.cjs --testPathPattern=bdd-wallet",
+    "bdd:wars": "jest --config jest.unit.config.cjs --testPathPattern=bdd-wars",
+    "bdd:integration": "jest --config jest.unit.config.cjs --testPathPattern=bdd-integration",
+    "bdd:performance": "jest --config jest.unit.config.cjs --testPathPattern=bdd-performance",
+    "coverage": "jest --config jest.unit.config.cjs --coverage",
+    "test:integration": "jest --config jest.integration.config.cjs",
+    "test:integration:live": "node -e \"process.env.ESI_LIVE_TESTS='true';require('child_process').execSync('npx jest --config jest.integration.config.cjs --testPathPattern=live-esi',{stdio:'inherit',env:Object.assign({},process.env,{ESI_LIVE_TESTS:'true'})})\"",
+    "test:integration:gated": "node --env-file=.env -e \"require('child_process').execSync('npx jest --config jest.integration.config.cjs --testPathPattern=gated-auth',{stdio:'inherit',env:Object.assign({},process.env,{ESI_GATED_TESTS:'true'})})\"",
+    "test:all": "npm run test && npm run bdd && npm run test:integration",
+    "knip": "knip",
+    "validate:esi": "ts-node scripts/validate-esi-endpoints.ts",
+    "validate": "npm run lint && npm run format:check && npm run build && npm run coverage && knip --no-exit-code",
+    "validate:versions": "ts-node scripts/validate-versions.ts",
+    "check:all": "npm run lint && npm run format:check && npm run build && npm run coverage && knip --no-exit-code && npm run validate:esi && npm run validate:versions",
+    "docs": "typedoc --options typedoc.json",
+    "docs:watch": "typedoc --options typedoc.json --watch",
+    "docs:serve": "npx http-server docs -p 8080 -o",
+    "clean": "rm -rf dist coverage docs",
+    "clean:docs": "rm -rf docs",
+    "prepare": "husky && npm run build",
+    "health-check": "ts-node -e \"import('./src/EsiClient').then(({EsiClient}) => new EsiClient().healthCheck().then(console.log))\""
+  },
+  "lint-staged": {
+    "src/**/*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "tests/**/*.ts": [
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "keywords": [
+    "eve-online",
+    "esi",
+    "api-client",
+    "typescript",
+    "eve",
+    "caching",
+    "rate-limiting",
+    "mmo"
+  ],
+  "author": "lgriffin",
+  "license": "GPL-3.0-or-later",
+  "homepage": "https://github.com/lgriffin/ESI.ts#readme",
+  "bugs": {
+    "url": "https://github.com/lgriffin/ESI.ts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lgriffin/ESI.ts"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^21.0.2",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^26.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "eslint-plugin-security": "^4.0.0",
+    "eslint-plugin-sonarjs": "^4.0.3",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-fetch-mock": "^3.0.3",
+    "jest-junit": "^17.0.0",
+    "knip": "^6.6.1",
+    "lint-staged": "^17.0.8",
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.4.11",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.18",
+    "typescript": "^6.0.3"
+  },
+  "dependencies": {
+    "winston": "^3.13.0"
+  }
+}

package/.github/workflows/ci.yml

@@ -1,16 +0,0 @@
-name: CI
-
-on: [push, pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: '14'
-      - run: npm install
-      - run: npm run build

package/.prettierrc

@@ -1,6 +0,0 @@
-{
-    "semi": true,
-    "singleQuote": true,
-    "printWidth": 80
-  }
-  

package/DOCUMENTATION.md

@@ -1,106 +0,0 @@
-# 📚 ESI.ts Documentation Guide
-
-## 🌐 Online Documentation
-
-The complete API documentation is automatically generated from the TypeScript source code and is available:
-
-- **Online**: [GitHub Pages](https://lgriffin.github.io/ESI.ts/) (if enabled)
-- **Locally**: Run `npm run docs:serve` to serve docs at `http://localhost:8080`
-
-## 📖 Documentation Structure
-
-### Main Sections
-
-1. **[Classes](docs/classes/index.html)** - All API clients and core classes
-   - `EsiClient` - Main client with all APIs
-   - `CustomEsiClient` - Lightweight client with selected APIs
-   - Individual clients (`CharacterClient`, `MarketClient`, etc.)
-
-2. **[Interfaces](docs/interfaces/index.html)** - TypeScript interfaces and contracts
-   - Configuration interfaces
-   - API response types
-   - Client contracts
-
-3. **[Functions](docs/functions/index.html)** - Utility functions and helpers
-   - Request handlers
-   - Validation utilities
-   - Test helpers
-
-4. **[Types](docs/types/index.html)** - Type aliases and custom types
-
-### Key Documentation Pages
-
-- **[EsiClient](docs/classes/src_EsiClient.EsiClient.html)** - Main client class
-- **[EsiClientBuilder](docs/classes/src_EsiClientBuilder.EsiClientBuilder.html)** - Builder pattern for custom clients
-- **[API Request Handler](docs/functions/src_core_ApiRequestHandler.handleRequest.html)** - Core request processing
-- **[ETag Caching](docs/functions/src_core_ApiRequestHandler.initializeETagCache.html)** - Performance caching system
-
-## 🔧 Documentation Commands
-
-```bash
-# Generate documentation
-npm run docs
-
-# Watch for changes and regenerate docs
-npm run docs:watch
-
-# Serve documentation locally at http://localhost:8080
-npm run docs:serve
-
-# Clean documentation folder
-npm run clean:docs
-
-# Clean all build artifacts (including docs)
-npm run clean
-```
-
-## 📝 Documentation Features
-
-### ✅ What's Included
-
-- **Complete API Coverage** - All classes, methods, and properties
-- **Type Information** - Full TypeScript type definitions
-- **Source Links** - Direct links to GitHub source code
-- **Search Functionality** - Built-in search across all documentation
-- **Inheritance Hierarchy** - Class inheritance relationships
-- **Cross-References** - Links between related classes and methods
-- **Examples** - Code examples from README and comments
-
-### 🎯 Navigation Tips
-
-1. **Search Box** - Use the search box in the top-right to find specific classes or methods
-2. **Module Tree** - Navigate through the organized module structure
-3. **Class Hierarchy** - View inheritance relationships
-4. **Source Links** - Click "Defined in" links to view source code on GitHub
-
-## 🚀 Quick Start Examples
-
-The documentation includes comprehensive examples for:
-
-- **Basic Usage** - Simple API calls
-- **Authentication** - Working with authenticated endpoints  
-- **Error Handling** - Proper error management
-- **Custom Clients** - Building lightweight clients
-- **ETag Caching** - Performance optimization
-- **Builder Pattern** - Fluent client construction
-
-## 📊 Documentation Quality
-
-- **Coverage**: 100% of public APIs documented
-- **Type Safety**: Full TypeScript type information
-- **Examples**: Practical usage examples
-- **Search**: Full-text search capability
-- **Mobile Friendly**: Responsive design for all devices
-
-## 🔄 Keeping Documentation Updated
-
-The documentation is automatically regenerated from source code, ensuring it's always current with the latest API changes. Key benefits:
-
-- **Always Current** - Reflects latest code changes
-- **Type Accurate** - TypeScript ensures type information is correct
-- **Comprehensive** - Covers all public APIs automatically
-- **Searchable** - Full-text search across all content
-
----
-
-**💡 Tip**: Bookmark the documentation site and use it as your primary reference when working with ESI.ts!