swcombine-sdk 3.2.5 → 3.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +21 -24
  2. package/package.json +4 -6
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  [![npm version](https://img.shields.io/npm/v/swcombine-sdk.svg)](https://www.npmjs.com/package/swcombine-sdk)
8
8
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.5+-blue.svg)](https://www.typescriptlang.org/)
9
9
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
10
- [![API Docs](https://img.shields.io/badge/API_Docs-TypeDoc-blue.svg)](https://jonmarkgo.github.io/swcombine-sdk-nodejs/)
10
+ [![API Docs](https://img.shields.io/badge/Docs-Mintlify-blue.svg)](https://swc-sdk.zeltros.dev/)
11
11
 
12
12
  [Features](#features) •
13
13
  [Installation](#installation) •
@@ -246,21 +246,21 @@ The SDK provides access to all SW Combine API v2.0 resources through a fluent, t
246
246
 
247
247
  | Resource | Access | Description |
248
248
  |---|---|---|
249
- | [`client.api`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_ApiResource.ApiResource.html) | Utilities | Hello world, permissions, rate limits, time conversion |
250
- | [`client.character`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_CharacterResource.CharacterResource.html) | Characters | Profile, [messages](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_CharacterResource.CharacterMessagesResource.html), [skills](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_CharacterResource.CharacterSkillsResource.html), [privileges](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_CharacterResource.CharacterPrivilegesResource.html), [credits](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_CharacterResource.CharacterCreditsResource.html), [credit log](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_CharacterResource.CharacterCreditlogResource.html) |
251
- | [`client.faction`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_FactionResource.FactionResource.html) | Factions | Info, [members](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_FactionResource.FactionMembersResource.html), [budgets](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_FactionResource.FactionBudgetsResource.html), [stockholders](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_FactionResource.FactionStockholdersResource.html), [credits](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_FactionResource.FactionCreditsResource.html), [credit log](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_FactionResource.FactionCreditlogResource.html) |
252
- | [`client.galaxy`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_GalaxyResource.GalaxyResource.html) | Galaxy | [Systems](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_GalaxyResource.GalaxySystemsResource.html), [sectors](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_GalaxyResource.GalaxySectorsResource.html), [planets](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_GalaxyResource.GalaxyPlanetsResource.html), [stations](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_GalaxyResource.GalaxyStationsResource.html), [cities](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_GalaxyResource.GalaxyCitiesResource.html) |
253
- | [`client.inventory`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_InventoryResource.InventoryResource.html) | Inventory | [Entity listing](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_InventoryResource.InventoryEntitiesResource.html), management, tagging |
254
- | [`client.market`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_MarketResource.MarketResource.html) | Market | [Vendor listings](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_MarketResource.MarketVendorsResource.html) |
255
- | [`client.news`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_NewsResource.NewsResource.html) | News | [GNS](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_NewsResource.GNSResource.html) and [Sim News](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_NewsResource.SimNewsResource.html) feeds |
256
- | [`client.types`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_TypesResource.TypesResource.html) | Types | [Entity types](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_TypesResource.TypesEntitiesResource.html), [classes](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_TypesResource.TypesClassesResource.html), and detailed type info |
257
- | [`client.events`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_EventsResource.EventsResource.html) | Events | Personal, faction, inventory, and combat events |
258
- | [`client.location`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_LocationResource.LocationResource.html) | Location | Entity location lookups |
259
- | [`client.datacard`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/resources_DatacardResource.DatacardResource.html) | Datacards | Datacard management and assignment |
260
-
261
- Also includes a [`Timestamp`](https://jonmarkgo.github.io/swcombine-sdk-nodejs/classes/Timestamp.Timestamp.html) utility for Combine Galactic Time (CGT) conversion and formatting.
262
-
263
- For complete method signatures, parameters, and examples, see the **[API Reference Documentation](https://jonmarkgo.github.io/swcombine-sdk-nodejs/)**.
249
+ | [`client.api`](https://swc-sdk.zeltros.dev/resources/character) | Utilities | Hello world, permissions, rate limits, time conversion |
250
+ | [`client.character`](https://swc-sdk.zeltros.dev/resources/character) | Characters | Profile, messages, skills, privileges, credits, credit log |
251
+ | [`client.faction`](https://swc-sdk.zeltros.dev/resources/faction) | Factions | Info, members, budgets, stockholders, credits, credit log |
252
+ | [`client.galaxy`](https://swc-sdk.zeltros.dev/resources/galaxy) | Galaxy | Systems, sectors, planets, stations, cities |
253
+ | [`client.inventory`](https://swc-sdk.zeltros.dev/resources/inventory) | Inventory | Entity listing, management, tagging |
254
+ | [`client.market`](https://swc-sdk.zeltros.dev/resources/market) | Market | Vendor listings |
255
+ | [`client.news`](https://swc-sdk.zeltros.dev/resources/news) | News | GNS and Sim News feeds |
256
+ | [`client.types`](https://swc-sdk.zeltros.dev/resources/types) | Types | Entity types, classes, and detailed type info |
257
+ | [`client.events`](https://swc-sdk.zeltros.dev/resources/events) | Events | Personal, faction, inventory, and combat events |
258
+ | [`client.location`](https://swc-sdk.zeltros.dev/resources/location) | Location | Entity location lookups |
259
+ | [`client.datacard`](https://swc-sdk.zeltros.dev/resources/datacard) | Datacards | Datacard management and assignment |
260
+
261
+ Also includes a [`Timestamp`](https://swc-sdk.zeltros.dev/guides/timestamp-utility) utility for Combine Galactic Time (CGT) conversion and formatting.
262
+
263
+ For complete method signatures, parameters, and examples, see the **[Documentation](https://swc-sdk.zeltros.dev/)**.
264
264
 
265
265
  ## Rate Limiting
266
266
 
@@ -415,15 +415,12 @@ npm run get-character-uid YourHandle
415
415
 
416
416
  ## Documentation
417
417
 
418
- - **[API Reference](https://jonmarkgo.github.io/swcombine-sdk-nodejs/)** - Full API reference with all methods, parameters, and examples
419
- - **[v2 → v3 Migration Guide](docs/MIGRATION-v3.md)** - Breaking changes and upgrade instructions
420
- - **[Getting Started Guide](docs/GETTING_STARTED.md)** - Detailed setup and usage
421
- - **[Authentication Guide](docs/AUTHENTICATION.md)** - OAuth 2.0 setup and token management
422
- - **[OAuth Scopes Reference](docs/SCOPES.md)** - Complete scope documentation
423
- - **[Getting an OAuth Token](docs/getting-oauth-token.md)** - Step-by-step token guide
418
+ - **[Full Documentation](https://swc-sdk.zeltros.dev/)** - Guides, API reference, and examples
419
+ - **[Quickstart](https://swc-sdk.zeltros.dev/quickstart)** - Install the SDK and make your first API call
420
+ - **[Authentication Guide](https://swc-sdk.zeltros.dev/authentication/overview)** - OAuth 2.0 setup and token management
421
+ - **[v2 → v3 Migration Guide](https://swc-sdk.zeltros.dev/guides/migration-v3)** - Breaking changes and upgrade instructions
424
422
  - **[Local Development](docs/LOCAL_DEVELOPMENT.md)** - Development environment setup
425
423
  - **[Publishing](docs/PUBLISHING.md)** - NPM publishing guide
426
- - **[Examples](examples/)** - Working code examples
427
424
 
428
425
  ## Development
429
426
 
@@ -459,7 +456,7 @@ npm run format
459
456
 
460
457
  ## Links
461
458
 
462
- - [SDK API Reference](https://jonmarkgo.github.io/swcombine-sdk-nodejs/) - Full TypeDoc-generated documentation
459
+ - [SDK Documentation](https://swc-sdk.zeltros.dev/) - Full documentation, guides, and API reference
463
460
  - [SW Combine API Documentation](https://www.swcombine.com/ws/developers/) - Official API docs
464
461
  - [npm Package](https://www.npmjs.com/package/swcombine-sdk)
465
462
  - [GitHub Repository](https://github.com/jonmarkgo/swcombine-sdk-nodejs)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "swcombine-sdk",
3
- "version": "3.2.5",
3
+ "version": "3.2.6",
4
4
  "description": "Comprehensive TypeScript SDK for Star Wars Combine API v2.0",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",
@@ -37,10 +37,8 @@
37
37
  "lint": "eslint src --ext .ts",
38
38
  "format": "prettier --write \"src/**/*.ts\"",
39
39
  "format:check": "prettier --check \"src/**/*.ts\"",
40
- "docs:api": "typedoc && tsx scripts/generate-llms-txt.ts",
41
- "docs:api:watch": "typedoc --watch",
42
- "docs:html": "typedoc --options typedoc.html.json",
43
- "docs:llms": "tsx scripts/generate-llms-txt.ts",
40
+ "docs": "typedoc && tsx scripts/generate-mintlify.ts",
41
+ "docs:watch": "typedoc --watch",
44
42
  "get-token": "tsx scripts/get-oauth-token.ts",
45
43
  "get-character-uid": "tsx scripts/get-character-uid.ts",
46
44
  "refresh-token": "tsx scripts/refresh-token.ts",
@@ -68,7 +66,7 @@
68
66
  "bugs": {
69
67
  "url": "https://github.com/jonmarkgo/swcombine-sdk-nodejs/issues"
70
68
  },
71
- "homepage": "https://jonmarkgo.github.io/swcombine-sdk-nodejs/",
69
+ "homepage": "https://swc-sdk.zeltros.dev/",
72
70
  "engines": {
73
71
  "node": ">=18.0.0"
74
72
  },