@lgriffin/esi.ts 1.0.0 → 2.0.0

package/demo/examples.ts

@@ -0,0 +1,250 @@
+/**
+ * Demo/Example usage of the ESI.ts library
+ * This file contains examples and test scenarios that were previously in index.ts
+ */
+
+import { EsiClient } from '../src/EsiClient';
+import { ApiError } from '../src/core/errors/ApiError';
+import logger from '../src/core/logger/logger';
+
+// Demo data
+const demoCharacter = 1689391488;
+const demoCorp = 98742334;
+const demoAlliance = 99005338;
+const demoWarId = 740620;
+const demoItemIds = [111, 222, 333];
+
+class EsiExamples {
+    private client: EsiClient;
+
+    constructor() {
+        this.client = new EsiClient();
+    }
+
+    async runAllExamples(): Promise<void> {
+        logger.info('Starting ESI.ts examples...');
+
+        try {
+            await this.testFactionAPIs();
+            await this.testAllianceAPIs();
+            await this.testWarsAPI();
+            await this.testUniverseAPIs();
+            await this.testCharacterAPIs();
+            await this.testErrorHandling();
+            await this.testPerformance();
+        } catch (error) {
+            logger.error('Error running examples:', error);
+        } finally {
+            await this.client.shutdown();
+        }
+    }
+
+    private async testFactionAPIs(): Promise<void> {
+        logger.info('=== Testing Faction APIs ===');
+        
+        try {
+            logger.info('Testing Faction Warfare Character Stats');
+            const characterStats = await this.client.factions.getCharacterStats(demoCharacter);
+            logger.info('Character Stats:', JSON.stringify(characterStats, null, 2));
+
+            logger.info('Testing Faction Warfare Corporation Stats');
+            const corporationStats = await this.client.factions.getCorporationStats(demoCorp);
+            logger.info('Corporation Stats:', JSON.stringify(corporationStats, null, 2));
+
+            logger.info('Testing Faction Warfare Leaderboards - Characters');
+            const leaderboardsCharacters = await this.client.factions.getLeaderboardsCharacters();
+            logger.info('Leaderboards - Characters:', JSON.stringify(leaderboardsCharacters, null, 2));
+
+            logger.info('Testing Faction Warfare Systems');
+            const systems = await this.client.factions.getSystems();
+            logger.info('Systems:', JSON.stringify(systems, null, 2));
+        } catch (error) {
+            this.handleError('Faction APIs', error);
+        }
+    }
+
+    private async testAllianceAPIs(): Promise<void> {
+        logger.info('=== Testing Alliance APIs ===');
+        
+        try {
+            logger.info('Testing Alliance Info');
+            const allianceInfo = await this.client.alliance.getAllianceById(demoAlliance);
+            logger.info('Alliance Info:', JSON.stringify(allianceInfo, null, 2));
+
+            logger.info('Testing Alliance Contacts');
+            const allianceContacts = await this.client.alliance.getContacts(demoAlliance);
+            logger.info('Alliance Contacts:', JSON.stringify(allianceContacts, null, 2));
+
+            logger.info('Testing Alliance Contact Labels');
+            const allianceContactLabels = await this.client.alliance.getContactLabels(demoAlliance);
+            logger.info('Alliance Contact Labels:', JSON.stringify(allianceContactLabels, null, 2));
+
+            logger.info('Testing Alliance Corporations');
+            const allianceCorporations = await this.client.alliance.getCorporations(demoAlliance);
+            logger.info('Alliance Corporations:', JSON.stringify(allianceCorporations, null, 2));
+
+            logger.info('Testing Alliance Icons');
+            const allianceIcons = await this.client.alliance.getIcons(demoAlliance);
+            logger.info('Alliance Icons:', JSON.stringify(allianceIcons, null, 2));
+        } catch (error) {
+            this.handleError('Alliance APIs', error);
+        }
+    }
+
+    private async testWarsAPI(): Promise<void> {
+        logger.info('=== Testing Wars APIs ===');
+
+        try {
+            logger.info('Testing War Info');
+            const warInfo = await this.client.wars.getWarById(demoWarId);
+            logger.info('War Info:', JSON.stringify(warInfo, null, 2));
+
+            logger.info('Testing War Killmails');
+            const warKillmails = await this.client.wars.getWarKillmails(demoWarId);
+            logger.info('War Killmails:', JSON.stringify(warKillmails, null, 2));
+
+            logger.info('Testing Getting Wars');
+            const activeWars = await this.client.wars.getWars();
+            logger.info('Active Wars Count:', activeWars.length);
+        } catch (error) {
+            this.handleError('Wars APIs', error);
+        }
+    }
+
+    private async testUniverseAPIs(): Promise<void> {
+        logger.info('=== Testing Universe APIs ===');
+
+        try {
+            logger.info('Testing Universe Ancestries');
+            const ancestries = await this.client.universe.getAncestries();
+            logger.info('Ancestries Count:', ancestries.length);
+
+            logger.info('Testing Universe Bloodlines');
+            const bloodlines = await this.client.universe.getBloodlines();
+            logger.info('Bloodlines Count:', bloodlines.length);
+
+            logger.info('Testing Universe Constellations');
+            const constellations = await this.client.universe.getConstellations();
+            logger.info('Constellations Count:', constellations.length);
+
+            // Test specific system
+            if (constellations.length > 0) {
+                const firstConstellation = constellations[0];
+                logger.info('Testing specific constellation:', firstConstellation);
+                const constellationInfo = await this.client.universe.getConstellationInfo(firstConstellation);
+                logger.info('Constellation Info:', JSON.stringify(constellationInfo, null, 2));
+            }
+        } catch (error) {
+            this.handleError('Universe APIs', error);
+        }
+    }
+
+    private async testCharacterAPIs(): Promise<void> {
+        logger.info('=== Testing Character APIs ===');
+
+        try {
+            logger.info('Testing Character Public Info');
+            const characterInfo = await this.client.characters.getCharacterPublicInfo(demoCharacter);
+            logger.info('Character Info:', JSON.stringify(characterInfo, null, 2));
+
+            logger.info('Testing Character Portrait');
+            const portrait = await this.client.characters.getPortrait(demoCharacter);
+            logger.info('Character Portrait URLs:', JSON.stringify(portrait, null, 2));
+        } catch (error) {
+            this.handleError('Character APIs', error);
+        }
+    }
+
+    private async testErrorHandling(): Promise<void> {
+        logger.info('=== Testing Error Handling ===');
+
+        try {
+            // Test with invalid alliance ID
+            await this.client.alliance.getAllianceById(-1);
+        } catch (error) {
+            if (error instanceof ApiError) {
+                logger.info('Successfully caught and handled API error:', {
+                    type: error.type,
+                    message: error.message,
+                    statusCode: error.statusCode,
+                    timestamp: error.timestamp
+                });
+            }
+        }
+
+        try {
+            // Test with non-existent resource
+            await this.client.alliance.getAllianceById(999999999);
+        } catch (error) {
+            if (error instanceof ApiError) {
+                logger.info('Successfully caught not found error:', {
+                    type: error.type,
+                    statusCode: error.statusCode
+                });
+            }
+        }
+    }
+
+    private async testPerformance(): Promise<void> {
+        logger.info('=== Testing Performance ===');
+
+        const startTime = Date.now();
+        
+        try {
+            // Test concurrent requests
+            const promises = [
+                this.client.alliance.getAllianceById(demoAlliance),
+                this.client.characters.getCharacterPublicInfo(demoCharacter),
+                this.client.universe.getConstellations()
+            ];
+
+            const results = await Promise.all(promises);
+            const endTime = Date.now();
+
+            logger.info(`Concurrent requests completed in ${endTime - startTime}ms`);
+            logger.info('Results received:', results.length);
+        } catch (error) {
+            this.handleError('Performance test', error);
+        }
+    }
+
+    private handleError(context: string, error: any): void {
+        if (error instanceof ApiError) {
+            logger.error(`${context} - API Error:`, {
+                type: error.type,
+                message: error.message,
+                statusCode: error.statusCode,
+                details: error.details
+            });
+        } else {
+            logger.error(`${context} - Unexpected Error:`, error);
+        }
+    }
+
+    async demonstrateClientInfo(): Promise<void> {
+        logger.info('=== Client Information ===');
+        
+        const clientInfo = this.client.getClientInfo();
+        logger.info('Available clients:', clientInfo.clients);
+        logger.info('Registered modules:', clientInfo.modules);
+
+        const healthCheck = await this.client.healthCheck();
+        logger.info('Health check results:', healthCheck);
+    }
+}
+
+// Run examples if this file is executed directly
+if (require.main === module) {
+    const examples = new EsiExamples();
+    examples.runAllExamples()
+        .then(() => {
+            logger.info('All examples completed successfully');
+            process.exit(0);
+        })
+        .catch((error) => {
+            logger.error('Examples failed:', error);
+            process.exit(1);
+        });
+}
+
+export { EsiExamples };

package/demo/flexible-examples.ts

@@ -0,0 +1,166 @@
+/**
+ * Flexible API Usage Examples
+ * 
+ * This demonstrates the different ways to use ESI.ts APIs:
+ * 1. Full ESI Client
+ * 2. Custom lightweight client
+ * 3. Individual API clients
+ * 4. Direct API instantiation
+ */
+
+import { 
+  EsiClient, 
+  CustomEsiClient, 
+  EsiClientBuilder, 
+  EsiApiFactory,
+  CharacterClient,
+  ApiClientBuilder 
+} from '../src/index';
+
+const DEMO_CHARACTER_ID = 1689391488;
+
+async function demonstrateFlexibleUsage() {
+  console.log('🚀 ESI.ts Flexible API Usage Examples');
+  console.log('=====================================\n');
+
+  // 1. Full ESI Client (All APIs)
+  console.log('1️⃣  Full ESI Client (All APIs)');
+  console.log('--------------------------------');
+  const fullClient = new EsiClient({
+    clientId: 'full-client-demo'
+  });
+
+  const character1 = await fullClient.characters.getCharacterPublicInfo(DEMO_CHARACTER_ID);
+  console.log(`✅ Character: ${character1.body.name} (using full client)`);
+  await fullClient.shutdown();
+
+  // 2. Custom Lightweight Client (Selected APIs)
+  console.log('\n2️⃣  Custom Lightweight Client (Selected APIs)');
+  console.log('----------------------------------------------');
+  const customClient = new CustomEsiClient({
+    clientId: 'custom-client-demo',
+    clients: ['characters', 'corporations'] // Only load what we need
+  });
+
+  const character2 = await customClient.characters?.getCharacterPublicInfo(DEMO_CHARACTER_ID);
+  console.log(`✅ Character: ${character2?.body.name} (using custom client)`);
+  console.log(`📊 Enabled clients: ${customClient.getEnabledClients().join(', ')}`);
+  await customClient.shutdown();
+
+  // 3. Builder Pattern
+  console.log('\n3️⃣  Builder Pattern');
+  console.log('-------------------');
+  const builtClient = new EsiClientBuilder()
+    .addClient('characters')
+    .addClient('universe')
+    .withClientId('builder-demo')
+    .build();
+
+  const character3 = await builtClient.characters?.getCharacterPublicInfo(DEMO_CHARACTER_ID);
+  console.log(`✅ Character: ${character3?.body.name} (using builder pattern)`);
+  await builtClient.shutdown();
+
+  // 4. Individual API Client (Ultra Lightweight)
+  console.log('\n4️⃣  Individual API Client (Ultra Lightweight)');
+  console.log('----------------------------------------------');
+  const characterClient = EsiApiFactory.createCharacterClient({
+    clientId: 'standalone-character-client'
+  });
+
+  const character4 = await characterClient.getCharacterPublicInfo(DEMO_CHARACTER_ID);
+  console.log(`✅ Character: ${character4.body.name} (using standalone client)`);
+
+  // 5. Direct API Class Instantiation
+  console.log('\n5️⃣  Direct API Class Instantiation');
+  console.log('----------------------------------');
+  const apiClient = new ApiClientBuilder()
+    .setClientId('direct-api-demo')
+    .setLink('https://esi.evetech.net')
+    .build();
+
+  const directCharacterClient = new CharacterClient(apiClient);
+  const character5 = await directCharacterClient.getCharacterPublicInfo(DEMO_CHARACTER_ID);
+  console.log(`✅ Character: ${character5.body.name} (using direct instantiation)`);
+
+  console.log('\n🎯 Performance Comparison');
+  console.log('=========================');
+  
+  // Measure startup times
+  console.log('⏱️  Startup time comparison:');
+  
+  // Full client startup
+  const fullStart = Date.now();
+  const fullTestClient = new EsiClient({ clientId: 'perf-test-full' });
+  const fullEnd = Date.now();
+  console.log(`   Full Client: ${fullEnd - fullStart}ms`);
+  await fullTestClient.shutdown();
+
+  // Custom client startup
+  const customStart = Date.now();
+  const customTestClient = new CustomEsiClient({ 
+    clientId: 'perf-test-custom', 
+    clients: ['characters'] 
+  });
+  const customEnd = Date.now();
+  console.log(`   Custom Client (1 API): ${customEnd - customStart}ms`);
+  await customTestClient.shutdown();
+
+  // Individual client startup
+  const individualStart = Date.now();
+  const individualTestClient = EsiApiFactory.createCharacterClient({ 
+    clientId: 'perf-test-individual' 
+  });
+  const individualEnd = Date.now();
+  console.log(`   Individual Client: ${individualEnd - individualStart}ms`);
+
+  console.log('\n✨ All examples completed successfully!');
+}
+
+// Microservice example
+async function priceServiceExample() {
+  console.log('\n💰 Microservice Example: Price Service');
+  console.log('======================================');
+
+  class PriceService {
+    private marketClient;
+
+    constructor() {
+      // Only load the market API
+      this.marketClient = EsiApiFactory.createMarketClient({
+        clientId: 'price-service-v1'
+      });
+    }
+
+    async getCurrentPrice(typeId: number): Promise<number> {
+      try {
+        const prices = await this.marketClient.getMarketPrices();
+        const price = prices.body.find((p: any) => p.type_id === typeId);
+        return price?.average_price || 0;
+      } catch (error) {
+        console.error('Failed to get price:', error);
+        return 0;
+      }
+    }
+  }
+
+  const priceService = new PriceService();
+  const tritaniumPrice = await priceService.getCurrentPrice(34); // Tritanium
+  console.log(`💎 Tritanium average price: ${tritaniumPrice.toFixed(2)} ISK`);
+}
+
+// Run all examples
+async function runAllExamples() {
+  try {
+    await demonstrateFlexibleUsage();
+    await priceServiceExample();
+  } catch (error) {
+    console.error('Error running examples:', error);
+  }
+}
+
+// Run if this file is executed directly
+if (require.main === module) {
+  runAllExamples().catch(console.error);
+}
+
+export { demonstrateFlexibleUsage, priceServiceExample };

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/highlight.css

@@ -0,0 +1,106 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #AF00DB;
+    --dark-hl-3: #C586C0;
+    --light-hl-4: #001080;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #008000;
+    --dark-hl-5: #6A9955;
+    --light-hl-6: #0000FF;
+    --dark-hl-6: #569CD6;
+    --light-hl-7: #0070C1;
+    --dark-hl-7: #4FC1FF;
+    --light-hl-8: #098658;
+    --dark-hl-8: #B5CEA8;
+    --light-hl-9: #000000FF;
+    --dark-hl-9: #D4D4D4;
+    --light-hl-10: #267F99;
+    --dark-hl-10: #4EC9B0;
+    --light-hl-11: #000000;
+    --dark-hl-11: #C8C8C8;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+pre, code { background: var(--code-background); }

package/docs/assets/icons.js

@@ -0,0 +1,18 @@
+(function() {
+    addIcons();
+    function addIcons() {
+        if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons);
+        const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg"));
+        svg.innerHTML = `<g id="icon-1" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-2" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">N</text></g><g id="icon-8" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">E</text></g><g id="icon-16" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-32" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">V</text></g><g id="icon-64" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-128" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-256" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">I</text></g><g id="icon-512" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-1024" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-2048" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-method)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4096" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-8192" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-16384" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-32768" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-65536" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-131072" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-262144" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-524288" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-1048576" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-2097152" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-4194304" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-reference)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">R</text></g><g id="icon-8388608" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="6,5 6,19 18,19, 18,10 13,5"></polygon><line x1="9" y1="9" x2="13" y2="9"></line><line x1="9" y1="12" x2="15" y2="12"></line><line x1="9" y1="15" x2="15" y2="15"></line></g></g><g id="icon-folder" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="5,5 10,5 12,8 19,8 19,18 5,18"></polygon></g></g><g id="icon-chevronDown" class="tsd-no-select"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-icon-text)"></path></g><g id="icon-chevronSmall" class="tsd-no-select"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-icon-text)"></path></g><g id="icon-checkbox" class="tsd-no-select"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></g><g id="icon-menu" class="tsd-no-select"><rect x="1" y="3" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-icon-text)"></rect></g><g id="icon-search" class="tsd-no-select"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-icon-text)"></path></g><g id="icon-anchor" class="tsd-no-select"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g>`;
+        svg.style.display = "none";
+        if (location.protocol === "file:") updateUseElements();
+    }
+
+    function updateUseElements() {
+        document.querySelectorAll("use").forEach(el => {
+            if (el.getAttribute("href").includes("#icon-")) {
+                el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#"));
+            }
+        });
+    }
+})()

package/docs/assets/icons.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg"><g id="icon-1" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-2" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">N</text></g><g id="icon-8" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">E</text></g><g id="icon-16" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-32" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">V</text></g><g id="icon-64" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-128" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-256" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">I</text></g><g id="icon-512" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-1024" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-2048" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-method)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4096" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-8192" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-16384" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-32768" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-65536" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-131072" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-262144" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-524288" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-1048576" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-2097152" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-4194304" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-reference)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">R</text></g><g id="icon-8388608" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="6,5 6,19 18,19, 18,10 13,5"></polygon><line x1="9" y1="9" x2="13" y2="9"></line><line x1="9" y1="12" x2="15" y2="12"></line><line x1="9" y1="15" x2="15" y2="15"></line></g></g><g id="icon-folder" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="5,5 10,5 12,8 19,8 19,18 5,18"></polygon></g></g><g id="icon-chevronDown" class="tsd-no-select"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-icon-text)"></path></g><g id="icon-chevronSmall" class="tsd-no-select"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-icon-text)"></path></g><g id="icon-checkbox" class="tsd-no-select"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></g><g id="icon-menu" class="tsd-no-select"><rect x="1" y="3" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-icon-text)"></rect></g><g id="icon-search" class="tsd-no-select"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-icon-text)"></path></g><g id="icon-anchor" class="tsd-no-select"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg>