@lgriffin/esi.ts 1.0.0

package/.github/workflows/ci.yml

@@ -0,0 +1,16 @@
+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

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

package/README.md

@@ -0,0 +1,127 @@
+# ESI.ts
+
+This repository contains a TypeScript implementation for the EVE Online API (ESI). This is inspired by the JavaScript implementation at https://github.com/ExperiBass/esiJS
+
+The project is a personal goal for me, I'm a lapsed developer (actively an Engineering Manager) going back to upskill in TypeScript after a decade away from development in Node.js and Java. Why TypeScript? Familarity with JavaScript and a hopefully better experience for anyone using my app.
+
+In my absence from coding, I have generated a lot of knowledge on concepts around architecture and design. So the intent of this application is to:
+
+- Build a clean architecture inspired application -- NOTE This will not be perfect, I'm going to try and adhere to it as best I can
+- Bring in Behaviour Driven Development to describe the intentions of the API for non expert programmers
+- Try and pursue a red-green TDD style approach for the APIs
+- Seperate the API into small, consumable usage
+- Look at design patterns, currently playing around with a Builder Pattern to eventually look at tailored client usage where we can have a slimmer client experience and create customised and narrower API profiles
+- Figure out how github actions work, I know enough of Jenkins to hopefully figure this out
+- Figure out caching and API management
+- Figure out auth flows and longer term token management and see can the API help here.
+- Develop a useful user guide and documentation
+
+This is most likely overkill for most end users, my goal is maintability and extensibility of the API and try and get a best practices project off the ground. The project is in flight, this first formal public commit is more to expose the intention and architecture. The factions API was chosen first just to have a mix of open calls and auth calls. This did not follow any best practices with testing and was an attempt to just get a functional API working. A lot of time was spent battling tooling (cucumber.js does not like TypeScript) and different integrations but this is at a point now where I am happy with the intentions. As I progress through each future API grouping my aim is to follow best practices and create a hopefully useful app for the EVE Online Community.
+
+ISK donations are always welcome to deiseman in game, reach out to chat about any ideas or how the design and API exposure could benefit your app.
+
+
+
+## API Implementation Status
+
+As progress is made I will try and update this to show what is functional and in place.
+
+### Faction Warfare
+- [x] Get Faction Warfare Leaderboards - Characters ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+- [x] Get Faction Warfare Leaderboards - Corporations ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+- [x] Get Faction Warfare Leaderboards - Overall ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+- [x] Get Faction Warfare Stats ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+- [x] Get Faction Warfare Character Stats ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+- [x] Get Faction Warfare Corporation Stats ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+- [x] Get Faction Warfare Systems ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+- [x] Get Faction Warfare Wars ![✔️](https://img.shields.io/badge/Status-Implemented-brightgreen)
+
+### Alliances
+- [ ] Get Alliance by ID ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Alliance Corporations ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Alliances ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Alliance Icons ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Bookmarks
+- [ ] Get Character Bookmarks ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Bookmark Folders ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Bookmarks ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Bookmark Folders ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Calendar
+- [ ] Get Character Calendar ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Calendar Event by ID ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Calendar Event Attendees ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Respond to Calendar Event ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Characters
+- [ ] Get Character by ID ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Agents Research ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Blueprints ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Corporation History ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Medals ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Notifications ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Portrait ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Roles ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Clones
+- [ ] Get Clones ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Jump Clones ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Implants ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Contacts
+- [ ] Get Character Contacts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Contacts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Alliance Contacts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Add Character Contacts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Edit Character Contacts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Delete Character Contacts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Contracts
+- [ ] Get Character Contracts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Contracts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Public Contracts ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Contract Bids ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Contract Items ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Corporations
+- [ ] Get Corporation by ID ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Assets ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Blueprints ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Divisions ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Facilities ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Icons ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Medals ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Members ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Dogma
+- [ ] Get Dogma Attributes ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Dogma Effects ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Fittings
+- [ ] Get Character Fittings ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Create Character Fitting ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Delete Character Fitting ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Fleets
+- [ ] Get Fleet by ID ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Fleet Members ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Invite Fleet Member ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Kick Fleet Member ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Update Fleet Member ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Fleet Wings ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Incursions
+- [ ] Get Incursions ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Industry
+- [ ] Get Industry Facilities ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Industry Systems ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Character Industry Jobs ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+- [ ] Get Corporation Industry Jobs ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Insurance
+- [ ] Get Insurance Prices ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)
+
+### Killmails
+- [ ] Get Character Killmails ![❌](https://img.shields.io/badge/Status-Not_Implemented-red)

package/Structure.js

@@ -0,0 +1,257 @@
+const fs = require('fs');
+const path = require('path');
+
+// This is just to try and create a structure for the architecture, implementatiton will follow. Keeping this around for now in github
+// List of API groups and their respective endpoints
+const apiStructure = {
+  alliances: [
+    'getAlliances',
+    'getAllianceById',
+    'getAllianceContacts',
+    'getAllianceContactLabels',
+    'getAllianceCorporations',
+    'getAllianceIcons'
+  ],
+  characters: [
+    'getCharacter',
+    'getCharacterAffiliation',
+    'getCharacterAgentsResearch',
+    'getCharacterAssets',
+    'getCharacterAssetLocations',
+    'getCharacterAssetNames',
+    'getCharacterAttributes',
+    'getCharacterBlueprints',
+    'getCharacterBookmarks',
+    'getCharacterBookmarkFolders',
+    'getCharacterCalendarEvents',
+    'getCharacterCalendarEventById',
+    'getCharacterClones',
+    'getCharacterContracts',
+    'getCharacterContractItems',
+    'getCharacterContractBids',
+    'getCharacterCorporationHistory',
+    'getCharacterFatigue',
+    'getCharacterFittings',
+    'getCharacterFleet',
+    'getCharacterFwStats',
+    'getCharacterImplants',
+    'getCharacterIndustryJobs',
+    'getCharacterKillmails',
+    'getCharacterLocation',
+    'getCharacterLoyaltyPoints',
+    'getCharacterMail',
+    'getCharacterMailLabels',
+    'getCharacterMailLists',
+    'getCharacterMailById',
+    'getCharacterMedals',
+    'getCharacterMining',
+    'getCharacterNotifications',
+    'getCharacterNotificationsContacts',
+    'getCharacterOpportunities',
+    'getCharacterOrders',
+    'getCharacterOrderHistory',
+    'getCharacterPlanets',
+    'getCharacterPortrait',
+    'getCharacterRoles',
+    'getCharacterSearch',
+    'getCharacterShip',
+    'getCharacterSkills',
+    'getCharacterSkillQueue',
+    'getCharacterStandings',
+    'getCharacterStats',
+    'getCharacterTitles',
+    'getCharacterWallet',
+    'getCharacterWalletJournal',
+    'getCharacterWalletTransactions'
+  ],
+  corporations: [
+    'getCorporation',
+    'getCorporationAlliances',
+    'getCorporationBlueprints',
+    'getCorporationBookmarks',
+    'getCorporationBookmarkFolders',
+    'getCorporationContacts',
+    'getCorporationContactLabels',
+    'getCorporationContracts',
+    'getCorporationContractBids',
+    'getCorporationContractItems',
+    'getCorporationContainerLogs',
+    'getCorporationDivisions',
+    'getCorporationFacilities',
+    'getCorporationFwStats',
+    'getCorporationIcons',
+    'getCorporationIndustryJobs',
+    'getCorporationKillmails',
+    'getCorporationMedals',
+    'getCorporationMembers',
+    'getCorporationMemberTracking',
+    'getCorporationMemberLimit',
+    'getCorporationMining',
+    'getCorporationNotifications',
+    'getCorporationOutposts',
+    'getCorporationOrders',
+    'getCorporationOrderHistory',
+    'getCorporationRoles',
+    'getCorporationShareholders',
+    'getCorporationStandings',
+    'getCorporationStarbases',
+    'getCorporationStructures',
+    'getCorporationTitles',
+    'getCorporationWallets',
+    'getCorporationWalletJournal',
+    'getCorporationWalletTransactions'
+  ],
+  universe: [
+    'getAncestries',
+    'getAsteroidBelt',
+    'getBloodlines',
+    'getCategories',
+    'getCategoryById',
+    'getConstellations',
+    'getConstellationById',
+    'getFactions',
+    'getGraphics',
+    'getGraphicById',
+    'getGroups',
+    'getGroupById',
+    'getMoons',
+    'getMoonById',
+    'getPlanets',
+    'getPlanetById',
+    'getRaces',
+    'getRegions',
+    'getRegionById',
+    'getStargates',
+    'getStargateById',
+    'getStars',
+    'getStarById',
+    'getStations',
+    'getStationById',
+    'getStructures',
+    'getSystemJumps',
+    'getSystemKills',
+    'getSystems',
+    'getSystemById',
+    'getTypes',
+    'getTypeById',
+    'getWars',
+    'getWarById',
+    'postBulkNamesToIds',
+    'postBulkIdsToNames',
+    'postUniverseNames'
+  ],
+  markets: [
+    'getMarketPrices',
+    'getMarketGroups',
+    'getMarketGroupById',
+    'getMarketOrders',
+    'getMarketHistory',
+    'getMarketRegionOrders',
+    'getMarketRegionHistory'
+  ],
+  industry: [
+    'getIndustrySystems',
+    'getIndustryFacilities',
+    'getIndustryJobs',
+    'getIndustryCorporationJobs'
+  ],
+  contracts: [
+    'getContracts',
+    'getContractById',
+    'getContractBids',
+    'getContractItems',
+    'getPublicContracts',
+    'getPublicContractBids',
+    'getPublicContractItems'
+  ],
+  factions: [
+    'getFactionWarfareStats',
+    'getFactionWarfareLeaderboards',
+    'getFactionWarfareSystems',
+    'getFactionWarfareWars'
+  ],
+  killmails: [
+    'getKillmails',
+    'getKillmailById',
+    'getRecentCharacterKillmails',
+    'getRecentCorporationKillmails'
+  ],
+  sovereignty: [
+    'getSovereigntyCampaigns',
+    'getSovereigntyMap',
+    'getSovereigntyStructures'
+  ],
+  opportunities: [
+    'getOpportunitiesTasks',
+    'getOpportunitiesGroups'
+  ],
+  fleets: [
+    'getFleets',
+    'getFleetMembers',
+    'getFleetWings',
+    'getFleetSquads'
+  ],
+  dogma: [
+    'getDogmaAttributes',
+    'getDogmaAttributeById',
+    'getDogmaEffects',
+    'getDogmaEffectById',
+    'getDogmaDynamicItemAttributes'
+  ],
+  incursions: [
+    'getIncursions'
+  ],
+  insurance: [
+    'getInsurancePrices'
+  ],
+  location: [
+    'getLocation'
+  ],
+  search: [
+    'postSearch'
+  ],
+  ui: [
+    'postUiAutopilotWaypoint',
+    'postUiOpenWindowContract',
+    'postUiOpenWindowInformation',
+    'postUiOpenWindowMarketDetails',
+    'postUiOpenWindowNewMail'
+  ],
+  wars: [
+    'getWars',
+    'getWarById'
+  ]
+};
+
+// Function to create directories and files
+const createDirectoriesAndFiles = (basePath, structure, type, extension) => {
+  Object.keys(structure).forEach(group => {
+    const groupPath = path.join(basePath, group);
+    fs.mkdirSync(groupPath, { recursive: true });
+
+    structure[group].forEach(endpoint => {
+      const filePath = path.join(groupPath, `${endpoint}.${extension}`);
+      fs.writeFileSync(filePath, '');
+    });
+  });
+};
+
+// Base paths
+const baseSrcPath = path.join(__dirname, 'src/api');
+const baseBddFeaturePath = path.join(__dirname, 'tests/bdd/features');
+const baseBddStepPath = path.join(__dirname, 'tests/bdd/step_definitions');
+const baseTddPath = path.join(__dirname, 'tests/tdd');
+
+// Create directories and files for API definitions
+createDirectoriesAndFiles(baseSrcPath, apiStructure, 'ts', 'ts');
+
+// Create directories and files for BDD tests (features)
+createDirectoriesAndFiles(baseBddFeaturePath, apiStructure, 'feature', 'feature');
+
+// Create directories and files for BDD tests (step definitions)
+createDirectoriesAndFiles(baseBddStepPath, apiStructure, 'steps', 'ts');
+
+// Create directories and files for TDD tests
+createDirectoriesAndFiles(baseTddPath, apiStructure, 'test', 'test.ts');
+
+console.log('Directory and file structure created successfully.');

package/eslint.json

@@ -0,0 +1,13 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "extends": [
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended"
+    ],
+    "parserOptions": {
+      "ecmaVersion": 2020,
+      "sourceType": "module"
+    },
+    "rules": {}
+  }
+  

package/jest.bdd.config.cjs

@@ -0,0 +1,22 @@
+const path = require('path');
+const glob = require('glob');
+
+console.log('Jest BDD Config Loaded');
+console.log('Root Directory:', path.resolve(__dirname));
+console.log('Looking for features in:', path.resolve(__dirname, 'tests/bdd/features'));
+
+const featureFiles = glob.sync(path.resolve(__dirname, 'tests/bdd/features/**/*.feature'));
+console.log('Discovered Feature Files:', featureFiles);
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  setupFilesAfterEnv: ['<rootDir>/src/config/jest/jest.bdd.setup.ts'],
+  testPathIgnorePatterns: ['/node_modules/', '/dist/', '/tests/tdd/'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest',
+  },
+  testMatch: ['**/tests/bdd/steps/**/*.ts'], // Adjust to match step definition files
+  verbose: true,
+};

package/jest.unit.config.cjs

@@ -0,0 +1,30 @@
+const path = require('path');
+
+console.log('Jest Unit Config Loaded');
+console.log('Root Directory:', path.resolve(__dirname));
+console.log('Looking for unit tests in:', path.resolve(__dirname, 'tests/tdd'));
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  setupFilesAfterEnv: ['<rootDir>/src/config/jest/jest.setup.ts'],
+  testPathIgnorePatterns: ['/node_modules/', '/dist/'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest',
+  },
+  testMatch: ['<rootDir>/tests/tdd/**/*.test.ts'],
+  verbose: true,
+  coverageDirectory: 'coverage/unit',
+  coverageReporters: ['text', 'lcov'],
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/index.ts',
+  ],
+  globals: {
+    'ts-jest': {
+      tsconfig: 'tsconfig.json',
+    },
+  },
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@lgriffin/esi.ts",
+  "version": "1.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",
+    "lint": "eslint . --ext .ts",
+    "test": "jest --config jest.unit.config.cjs",
+    "bdd": "jest --config jest.bdd.config.cjs",
+    "coverage": "jest --config jest.unit.config.cjs --coverage"
+  },
+  "keywords": [],
+  "author": "lgriffin",
+  "license": "GPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lgriffin/ESI.ts"
+  },
+  "devDependencies": {
+    "@cucumber/cucumber": "^10.8.0",
+    "@types/axios": "^0.14.0",
+    "@types/chai": "^4.3.16",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.5",
+    "@types/winston": "^2.4.4",
+    "@types/winston-loggly-bulk": "^3.0.6",
+    "@typescript-eslint/eslint-plugin": "^7.13.1",
+    "@typescript-eslint/parser": "^7.13.1",
+    "chai": "^5.1.1",
+    "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",
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.2.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "axios": "^1.7.2",
+    "winston": "^3.13.0",
+    "winston-loggly-bulk": "^3.3.0",
+    "winston-transport": "^4.7.0"
+  }
+}

package/src/TODO

@@ -0,0 +1,72 @@
+Development Roadmap
+
+
+
+
+Naming Conventions:
+Took a few different paths through it, need to look at export declarations in particular
+
+Location of APIs
+
+Looking at the ESI Spec, taking the Alliance as an example, there are 4 APIs. My approach wrapped the other /alliances endpoints such as in Contacts under Alliance to make it more logical.
+This means I need to check manually 1:1 to make sure all endpoints are there and that they are either logically mapping to the ESI or logically placed in a structure that I recognise. This is
+important because of the Client / Builder relationship so my thinking is to match the ESI spec identically and not mix up locations. This might lead to a custom builder that could pull all the /character
+or / alliance or /corp and make a holistic Builder/Client for that combination. This might lead to a structural refactor and have Builders and Clients matching the ESI and a Logical grouping of Builders/Clients then as a custom option
+
+Director and Builder pattern
+
+Look at the Director approach to ensure building custom APIs is a thing
+
+Authentication Issue:
+Need to flag what API end points need auth, this would either be a large refactor to pass in a boolean or would be a spec file we pull from to say API X needs auth
+This is an oversight on my part we do pass the boolean in but I forgot it on several routes.
+this is an easy fix and tests will break
+
+API Verb
+Not all passing in GET using the defaults in apirequesthandler which isn't clean. Handled this now but need to recheck the , undefined paramater and make sure its the right way instead of using JSON.stringify(object)
+
+Models:
+Need to review the request models particularly for issues and handle that gracefully
+
+
+Caching:
+See can I / should I consider caching here
+
+Rate Limiting:
+For some pages we will get rate limited, we might want to check the number of pages and decide to only request X every minute
+
+Pagination II
+General pagination is in place, I wonder can we request a specific page
+
+URL Tidy up:
+Construction of the URL to bring in different data sources, right now we don't add that to the URL but we should if it is present in the conf file
+
+Integration with Mock ESI data:
+Currently using a mix of my own mocks and real data. ESI Mock is a project, need to look to see can I bind against that
+
+Thourough Testing:
+Gaining ESI scopes is slowing me down, I need to revisit this with real requests to look at how it handles. Concerned about any API verb that's not a GET, this might require some refactoring as no
+doubt the return logic handling on things like PUT, POST and DELETE require something beyond what I have in place.
+
+Etags:
+returned in headers, check before a call. expose the tag perhaps?
+V 1.0.0
+Should be good to go live when all of the above are considered
+
+STATUS CLient:
+Looks to be implemented strangly
+
+204 APIs in Spec
+
+32 Builders
+32 Clients
+
+Current Test Suits: 263
+Should be: 268
+
+
+Testing Issues:
+AllianceClient test is incomplete
+ContactsClient as well
+Corporations as well
+getIncursions.test.ts needs a refactor

package/src/api/alliances/getAllianceById.ts

@@ -0,0 +1,10 @@
+import { ApiClient } from '../../core/ApiClient';
+import { handleRequest } from '../../core/ApiRequestHandler';
+
+export class AllianceByIdApi {
+    constructor(private client: ApiClient) {}
+
+    async getAllianceById(allianceId: number): Promise<object> {
+        return await handleRequest(this.client, `alliances/${allianceId}/`, 'GET', undefined, false);
+    }
+}

package/src/api/alliances/getAllianceContactLabels.ts

@@ -0,0 +1,11 @@
+import { ApiClient } from '../../core/ApiClient';
+import { handleRequest } from '../../core/ApiRequestHandler';
+
+
+export class AllianceContactLabelsApi {
+    constructor(private client: ApiClient) {}
+
+    async getAllianceContactLabels(allianceId: number): Promise<object[]> {
+        return handleRequest(this.client, `alliances/${allianceId}/contacts/labels`, 'GET', undefined, false);
+    }
+}

package/src/api/alliances/getAllianceContacts.ts

@@ -0,0 +1,10 @@
+import { ApiClient } from '../../core/ApiClient';
+import { handleRequest } from '../../core/ApiRequestHandler';
+
+export class AllianceContactsApi {
+    constructor(private client: ApiClient) {}
+
+    async getAllianceContacts(allianceId: number): Promise<object[]> {
+        return handleRequest(this.client, `alliances/${allianceId}/contacts`, 'GET', undefined, false);
+    }
+}

package/src/api/alliances/getAllianceCorporations.ts

@@ -0,0 +1,10 @@
+import { ApiClient } from '../../core/ApiClient';
+import { handleRequest } from '../../core/ApiRequestHandler';
+
+export class AllianceCorporationsApi {
+    constructor(private client: ApiClient) {}
+
+    async getAllianceCorporations(allianceId: number): Promise<object> {
+        return await handleRequest(this.client, `alliances/${allianceId}/corporations/`, 'GET', undefined, false);
+    }
+}

package/src/api/alliances/getAllianceIcons.ts

@@ -0,0 +1,10 @@
+import { ApiClient } from '../../core/ApiClient';
+import { handleRequest } from '../../core/ApiRequestHandler';
+
+export class AllianceIconsApi {
+    constructor(private client: ApiClient) {}
+
+    async getAllianceIcons(allianceId: number): Promise<object> {
+        return await handleRequest(this.client, `alliances/${allianceId}/icons/`, 'GET', undefined, false);
+    }
+}

package/src/api/alliances/getAlliances.ts

@@ -0,0 +1,10 @@
+import { ApiClient } from '../../core/ApiClient';
+import { handleRequest } from '../../core/ApiRequestHandler';
+
+export class AllAlliancesApi {
+    constructor(private client: ApiClient) {}
+
+    async getAllAlliances(): Promise<object[]> {
+        return handleRequest(this.client, 'alliances', 'GET', undefined, false);
+    }
+}