@lgriffin/esi.ts 1.0.0 → 2.0.0

package/tests/tdd/meta/MetaApiBuilder.test.ts

@@ -0,0 +1,45 @@
+import { ApiClient } from '../../../src/core/ApiClient';
+import { MetaApiBuilder } from '../../../src/builders/MetaApiBuilder';
+import { MetaClient } from '../../../src/clients/MetaClient';
+
+describe('MetaApiBuilder', () => {
+    let apiClient: jest.Mocked<ApiClient>;
+    let metaApiBuilder: MetaApiBuilder;
+
+    beforeEach(() => {
+        apiClient = {
+            request: jest.fn(),
+            get: jest.fn(),
+            post: jest.fn(),
+            put: jest.fn(),
+            delete: jest.fn()
+        } as any;
+
+        metaApiBuilder = new MetaApiBuilder(apiClient);
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    it('should create a new MetaApiBuilder instance', () => {
+        expect(metaApiBuilder).toBeInstanceOf(MetaApiBuilder);
+    });
+
+    it('should build and return a MetaClient instance', () => {
+        const metaClient = metaApiBuilder.build();
+        
+        expect(metaClient).toBeInstanceOf(MetaClient);
+        expect(metaClient.name).toBe('MetaClient');
+        expect(metaClient.version).toBe('1.0.0');
+    });
+
+    it('should pass the ApiClient to the MetaClient', () => {
+        const metaClient = metaApiBuilder.build();
+        
+        // Verify that the client is properly initialized with the API client
+        expect(metaClient).toBeDefined();
+        expect(typeof metaClient.getSwaggerJson).toBe('function');
+        expect(typeof metaClient.getSwaggerYaml).toBe('function');
+    });
+});

package/tests/tdd/meta/MetaClient.test.ts

@@ -0,0 +1,92 @@
+import { ApiClient } from '../../../src/core/ApiClient';
+import { MetaClient } from '../../../src/clients/MetaClient';
+import { GetSwaggerJsonApi } from '../../../src/api/meta/getSwaggerJson';
+import { GetSwaggerYamlApi } from '../../../src/api/meta/getSwaggerYaml';
+
+// Mock the API classes
+jest.mock('../../../src/api/meta/getSwaggerJson');
+jest.mock('../../../src/api/meta/getSwaggerYaml');
+
+describe('MetaClient', () => {
+    let apiClient: jest.Mocked<ApiClient>;
+    let metaClient: MetaClient;
+    let mockGetSwaggerJsonApi: jest.Mocked<GetSwaggerJsonApi>;
+    let mockGetSwaggerYamlApi: jest.Mocked<GetSwaggerYamlApi>;
+
+    beforeEach(() => {
+        apiClient = {
+            request: jest.fn(),
+            get: jest.fn(),
+            post: jest.fn(),
+            put: jest.fn(),
+            delete: jest.fn()
+        } as any;
+
+        mockGetSwaggerJsonApi = {
+            getSwaggerJson: jest.fn()
+        } as any;
+
+        mockGetSwaggerYamlApi = {
+            getSwaggerYaml: jest.fn()
+        } as any;
+
+        (GetSwaggerJsonApi as jest.Mock).mockImplementation(() => mockGetSwaggerJsonApi);
+        (GetSwaggerYamlApi as jest.Mock).mockImplementation(() => mockGetSwaggerYamlApi);
+
+        metaClient = new MetaClient(apiClient);
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    describe('getSwaggerJson', () => {
+        it('should call getSwaggerJson API and return result', async () => {
+            const mockSwaggerSpec = {
+                openapi: '3.0.0',
+                info: { title: 'EVE Swagger Interface', version: '1.0.0' }
+            };
+
+            mockGetSwaggerJsonApi.getSwaggerJson.mockResolvedValue(mockSwaggerSpec);
+
+            const result = await metaClient.getSwaggerJson();
+
+            expect(mockGetSwaggerJsonApi.getSwaggerJson).toHaveBeenCalledTimes(1);
+            expect(result).toEqual(mockSwaggerSpec);
+        });
+
+        it('should handle errors from getSwaggerJson API', async () => {
+            const mockError = new Error('API Error');
+            mockGetSwaggerJsonApi.getSwaggerJson.mockRejectedValue(mockError);
+
+            await expect(metaClient.getSwaggerJson()).rejects.toThrow('API Error');
+        });
+    });
+
+    describe('getSwaggerYaml', () => {
+        it('should call getSwaggerYaml API and return result', async () => {
+            const mockYamlSpec = 'openapi: 3.0.0\ninfo:\n  title: EVE Swagger Interface';
+
+            mockGetSwaggerYamlApi.getSwaggerYaml.mockResolvedValue(mockYamlSpec);
+
+            const result = await metaClient.getSwaggerYaml();
+
+            expect(mockGetSwaggerYamlApi.getSwaggerYaml).toHaveBeenCalledTimes(1);
+            expect(result).toEqual(mockYamlSpec);
+        });
+
+        it('should handle errors from getSwaggerYaml API', async () => {
+            const mockError = new Error('API Error');
+            mockGetSwaggerYamlApi.getSwaggerYaml.mockRejectedValue(mockError);
+
+            await expect(metaClient.getSwaggerYaml()).rejects.toThrow('API Error');
+        });
+    });
+
+    describe('client properties', () => {
+        it('should have correct name and version', () => {
+            expect(metaClient.name).toBe('MetaClient');
+            expect(metaClient.version).toBe('1.0.0');
+        });
+    });
+});

package/tests/tdd/meta/getSwaggerJson.test.ts

@@ -0,0 +1,40 @@
+import { GetSwaggerJsonApi } from '../../../src/api/meta/getSwaggerJson';
+import { getClient } from '../../../src/config/jest/jest.setup';
+import fetchMock from 'jest-fetch-mock';
+
+fetchMock.enableMocks();
+
+let getSwaggerJsonApi: GetSwaggerJsonApi;
+
+beforeAll(() => {
+    getSwaggerJsonApi = new GetSwaggerJsonApi(getClient());
+});
+
+describe('GetSwaggerJsonApi', () => {
+    beforeEach(() => {
+        fetchMock.resetMocks();
+    });
+
+    it('should call getSwaggerJson and return swagger specification', async () => {
+        const mockSwaggerSpec = {
+            openapi: '3.0.0',
+            info: { title: 'EVE Swagger Interface', version: '1.0.0' },
+            paths: {}
+        };
+
+        fetchMock.mockResponseOnce(JSON.stringify(mockSwaggerSpec));
+
+        const result = await getBody(() => getSwaggerJsonApi.getSwaggerJson());
+
+        expect(result).toEqual(mockSwaggerSpec);
+        expect(result).toHaveProperty('openapi', '3.0.0');
+        expect(result).toHaveProperty('info');
+        expect(result.info).toHaveProperty('title', 'EVE Swagger Interface');
+    });
+
+    it('should handle API errors gracefully', async () => {
+        fetchMock.mockRejectOnce(new Error('API Error'));
+
+        await expect(getBody(() => getSwaggerJsonApi.getSwaggerJson())).rejects.toThrow();
+    });
+});

package/tests/tdd/meta/getSwaggerYaml.test.ts

@@ -0,0 +1,40 @@
+import { GetSwaggerYamlApi } from '../../../src/api/meta/getSwaggerYaml';
+import { getClient } from '../../../src/config/jest/jest.setup';
+import fetchMock from 'jest-fetch-mock';
+
+fetchMock.enableMocks();
+
+let getSwaggerYamlApi: GetSwaggerYamlApi;
+
+beforeAll(() => {
+    getSwaggerYamlApi = new GetSwaggerYamlApi(getClient());
+});
+
+describe('GetSwaggerYamlApi', () => {
+    beforeEach(() => {
+        fetchMock.resetMocks();
+    });
+
+    it('should call getSwaggerYaml and return swagger specification as YAML string', async () => {
+        const mockYamlSpec = `openapi: 3.0.0
+info:
+  title: EVE Swagger Interface
+  version: 1.0.0
+paths: {}`;
+
+        fetchMock.mockResponseOnce(mockYamlSpec);
+
+        const result = await getSwaggerYamlApi.getSwaggerYaml();
+
+        expect(result).toEqual(mockYamlSpec);
+        expect(typeof result).toBe('string');
+        expect(result).toContain('openapi: 3.0.0');
+        expect(result).toContain('title: EVE Swagger Interface');
+    });
+
+    it('should handle API errors gracefully', async () => {
+        fetchMock.mockRejectOnce(new Error('API Error'));
+
+        await expect(getSwaggerYamlApi.getSwaggerYaml()).rejects.toThrow();
+    });
+});

package/tests/tdd/status/StatusClient.test.ts

@@ -1,22 +1,24 @@
 import { StatusClient } from '../../../src/clients/StatusClient';
 import { ApiClientBuilder } from '../../../src/core/ApiClientBuilder';
 import { getConfig } from '../../../src/config/configManager';
+import { getBody } from '../../../src/core/util/testHelpers';
 import fetchMock from 'jest-fetch-mock';
 
 fetchMock.enableMocks();
 
-const config = getConfig();
-const client = new ApiClientBuilder()
-    .setClientId(config.projectName)
-    .setLink(config.link)
-    .setAccessToken(config.authToken || undefined)
-    .build();
-
 describe('StatusClient', () => {
     let statusClient: StatusClient;
 
     beforeEach(() => {
         fetchMock.resetMocks();
+        
+        const config = getConfig();
+        const client = new ApiClientBuilder()
+            .setClientId(config.projectName)
+            .setLink(config.link)
+            .setAccessToken(config.authToken || undefined)
+            .build();
+
         statusClient = new StatusClient(client);
     });
 
@@ -29,7 +31,7 @@ describe('StatusClient', () => {
 
         fetchMock.mockResponseOnce(JSON.stringify(mockResponse));
 
-        const result = await getBody(() => statusClient.getStatus());
+        const result = await statusClient.getStatus();
 
         expect(result.players).toBe(12345);
         expect(result.start_time).toBe('2024-07-01T18:57:11Z');

package/tests/tdd/status/getStatus.test.ts

@@ -6,18 +6,20 @@ import fetchMock from 'jest-fetch-mock';
 
 fetchMock.enableMocks();
 
-const config = getConfig();
-const client = new ApiClientBuilder()
-    .setClientId(config.projectName)
-    .setLink(config.link)
-    .setAccessToken(config.authToken || undefined)
-    .build();
-
-const statusApi = new GetStatusApi(client);
-
 describe('GetStatusApi', () => {
+    let statusApi: GetStatusApi;
+
     beforeEach(() => {
         fetchMock.resetMocks();
+        
+        const config = getConfig();
+        const client = new ApiClientBuilder()
+            .setClientId(config.projectName)
+            .setLink(config.link)
+            .setAccessToken(config.authToken || undefined)
+            .build();
+
+        statusApi = new GetStatusApi(client);
     });
 
     it('should return valid status information', async () => {
@@ -31,7 +33,7 @@ describe('GetStatusApi', () => {
 
         fetchMock.mockResponseOnce(JSON.stringify(mockResponse));
 
-        const result = await getBody(() => statusApi.getStatus());
+        const result = await statusApi.getStatus();
 
         expect(result).toHaveProperty('players');
         expect(typeof result.players).toBe('object');

package/typedoc.json

@@ -0,0 +1,77 @@
+{
+  "entryPointStrategy": "expand",
+  "entryPoints": ["src"],
+  "out": "docs",
+  "name": "@lgriffin/esi.ts - EVE Online ESI API Client",
+  "theme": "default",
+  "readme": "./README.md",
+  "includeVersion": true,
+  "excludePrivate": true,
+  "excludeProtected": false,
+  "excludeInternal": true,
+  "excludeExternals": true,
+  "categorizeByGroup": true,
+  "defaultCategory": "Other",
+  "categoryOrder": [
+    "Clients",
+    "Core",
+    "API",
+    "Builders",
+    "Configuration",
+    "Utilities",
+    "Types",
+    "*"
+  ],
+  "exclude": [
+    "**/*.test.ts",
+    "**/*.spec.ts",
+    "**/tests/**/*",
+    "**/demo/**/*",
+    "**/node_modules/**/*",
+    "**/dist/**/*",
+    "**/coverage/**/*"
+  ],
+  "excludeNotDocumented": false,
+  "plugin": [],
+  "sort": ["source-order"],
+  "kindSortOrder": [
+    "Document",
+    "Project",
+    "Module",
+    "Namespace", 
+    "Enum",
+    "Class",
+    "Interface",
+    "TypeAlias",
+    "Constructor",
+    "Property",
+    "Variable",
+    "Function",
+    "Accessor",
+    "Method"
+  ],
+  "navigation": {
+    "includeCategories": true,
+    "includeGroups": true
+  },
+  "searchInComments": true,
+  "cleanOutputDir": true,
+  "titleLink": "https://github.com/lgriffin/ESI.ts",
+  "navigationLinks": {
+    "GitHub": "https://github.com/lgriffin/ESI.ts",
+    "NPM": "https://www.npmjs.com/package/@lgriffin/esi.ts"
+  },
+  "sidebarLinks": {
+    "ESI Documentation": "https://esi.evetech.net/ui/",
+    "EVE Online": "https://www.eveonline.com/"
+  },
+  "githubPages": true,
+  "gitRevision": "main",
+  "gitRemote": "origin",
+  "sourceLinkTemplate": "https://github.com/lgriffin/ESI.ts/blob/{gitRevision}/{path}#L{line}",
+  "disableSources": false,
+  "basePath": "./",
+  "markdownItOptions": {
+    "html": true
+  }
+}

package/Structure.js

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

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

package/jest.bdd.config.cjs

@@ -1,22 +0,0 @@
-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/src/config/jest/jest.bdd.setup.ts

@@ -1,11 +0,0 @@
-import { setWorldConstructor } from '@cucumber/cucumber';
-
-export class CustomWorld {
-  constructor() {
-    // Initialization code
-  }
-
-  // Define any shared state or methods needed for tests
-}
-
-setWorldConstructor(CustomWorld);

package/tests/bdd/features/alliances/getAllianceById.feature

@@ -1,6 +0,0 @@
-Feature: Get Alliance Information by ID
-
-  Scenario: Retrieve alliance information with a valid ID
-    Given an alliance with ID "99000006" exists
-    When I request the alliance information for ID "99000006"
-    Then the response should contain the alliance name "Goonswarm Federation"