Quickstart

import { SWCombine, AccessType } from 'swcombine-sdk';

// Public mode — no credentials required.
// Use this for endpoints that don't need authentication.
const publicClient = new SWCombine();

// Token-only mode — provide an existing access token.
// Use this when you already have a token and don't need OAuth flows.
const tokenClient = new SWCombine({
  token: process.env.SWC_ACCESS_TOKEN!,
});

// Full OAuth mode — required for OAuth flows and automatic token refresh.
// Provide your OAuth app credentials along with an optional token.
const fullClient = new SWCombine({
  clientId: process.env.SWC_CLIENT_ID!,
  clientSecret: process.env.SWC_CLIENT_SECRET!,
  token: process.env.SWC_ACCESS_TOKEN, // Optional: skip if you don't have one yet
  redirectUri: 'http://localhost:3000/callback',
  accessType: AccessType.Offline, // Request a refresh token
});

// No auth needed — public mode works here
const { uid, handle } = await publicClient.character.getByHandle({
  handle: 'your-character-handle',
});

console.log(uid);    // "1:12345"
console.log(handle); // "your-character-handle"

const client = new SWCombine({
  token: process.env.SWC_ACCESS_TOKEN!,
});

const character = await client.character.get({
  uid: '1:12345',
});

console.log(character.name);    // Character name
console.log(character.credits); // Credit balance
console.log(character.faction); // Faction info

const me = await client.character.me();
console.log(me.name); // Your character's name

import { Page } from 'swcombine-sdk';

// Fetch the first page of galaxy sectors
const firstPage = await client.galaxy.sectors.list();

console.log(firstPage.total);          // Total sectors across all pages
console.log(firstPage.data.length);    // Sectors on this page
console.log(firstPage.hasMore);        // true if more pages exist

// Fetch the next page manually
if (firstPage.hasMore) {
  const secondPage = await firstPage.getNextPage();
}

// Auto-paginate with for-await — yields every item across all pages
for await (const sector of await client.galaxy.sectors.list()) {
  console.log(sector.name);
}