swcombine.js 0.0.2 → 0.0.3

package/dist/index.d.ts

@@ -1,5 +1,497 @@
-export * from '@/resources';
-export * from '@/responses';
-export * from '@/types';
-export * from '@/permissions';
-//# sourceMappingURL=index.d.ts.map
+declare class AuthenticatedCharacterResource extends PublicCharacterResource {
+    private auth;
+    constructor(auth: AuthService);
+    getCurrentCharacter(): Promise<CharacterResponse>;
+}
+
+export declare class AuthService {
+    private config;
+    private tokenInfo?;
+    constructor(config: OAuthConfig);
+    get isAuthenticated(): boolean;
+    getAccessToken(): Promise<string>;
+    /**
+     *
+     * @param scopesToRequest Indicates the resource access your application is requesting. The values passed in this parameter inform the consent page shown to the user. There is an inverse relationship between the number of permissions requested and the likelihood of obtaining user consent
+     * @param stateToAdd Indicates any state which may be useful to your application upon receipt of the response. The Web Service Authorization Server roundtrips this parameter, so your application receives the same value it sent. Possible uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.
+     */
+    getAuthorizationUrl(scopesToRequest?: string[], stateToAdd?: string): string;
+    exchangeCode(code: string): Promise<void>;
+    setTokenInfo(tokenInfo: TokenInfo): void;
+    getTokenInfo(): TokenInfo | undefined;
+    private refreshToken;
+}
+
+declare interface CharacterFaction {
+    uid: SwcUid;
+    name: string;
+    isPrimary: boolean;
+}
+
+declare type CharacterFactionPrivileges = {
+    factionId: number;
+    factionName: string;
+    privilegeCount: number;
+    privileges: {
+        setInfoFields: boolean;
+        viewMemberList: boolean;
+        acceptOrDeclineMembers: boolean;
+        expelMembers: boolean;
+        isFactionLeader: boolean;
+        viewCredits: boolean;
+        sendCredits: boolean;
+        viewTransactions: boolean;
+        viewBudgets: boolean;
+        modifyBudgets: boolean;
+        setTaxLevels: boolean;
+        operateVendors: boolean;
+        givePrivileges: boolean;
+        changePasscode: boolean;
+        protectAssets: boolean;
+        combatEvents: boolean;
+        manageTemplates: boolean;
+        canSeeOverview: boolean;
+        canViewPanelRequests: boolean;
+        enforceArrestWarrant: boolean;
+        enforceDeathWarrant: boolean;
+        releasePrisoners: boolean;
+        issueArrestWarrant: boolean;
+        issueDeathWarrant: boolean;
+        modifyFriendFoeList: boolean;
+        hasSecurityAuthorisation: boolean;
+        postGnsSocial: boolean;
+        postGnsMilitary: boolean;
+        postGnsPolitics: boolean;
+        postGnsEconomics: boolean;
+        gnsCensorship: boolean;
+        produceInFacilities: boolean;
+        produceInStations: boolean;
+        canAbortProduction: boolean;
+        assignDatacards: boolean;
+        revokeAssignedDatacards: boolean;
+        constructFacilities: boolean;
+        constructCities: boolean;
+        constructStations: boolean;
+        canAbortConstruction: boolean;
+        performAsteroidMining: boolean;
+        performRecycling: boolean;
+        purchaseNpcs: boolean;
+        editNpcs: boolean;
+        fireNpcs: boolean;
+        isSecondInCommand: boolean;
+        assignTags: boolean;
+        renameTags: boolean;
+        createTags: boolean;
+        deleteTags: boolean;
+        viewCombatReports: boolean;
+        launchGarrisonSquad: boolean;
+        modifyGarrisonReserve: boolean;
+        launchCargoSquad: boolean;
+        linkCargoBase: boolean;
+        viewCargoSquad: boolean;
+        changeFactionProfile: boolean;
+        renameFaction: boolean;
+        factionCustomImages: boolean;
+        createSubfactions: boolean;
+        manageSubfactionMembers: boolean;
+        subfactionFullPrivileges: boolean;
+        manageFactionModules: boolean;
+        manageAlliance: boolean;
+        viewShips: boolean;
+        assignShips: boolean;
+        renameShips: boolean;
+        makeoverShips: boolean;
+        viewVehicles: boolean;
+        assignVehicles: boolean;
+        renameVehicles: boolean;
+        makeoverVehicles: boolean;
+        viewItems: boolean;
+        assignItems: boolean;
+        renameItems: boolean;
+        makeoverItems: boolean;
+        viewDroids: boolean;
+        assignDroids: boolean;
+        renameDroids: boolean;
+        makeoverDroids: boolean;
+        viewStations: boolean;
+        assignStations: boolean;
+        renameStations: boolean;
+        makeoverStations: boolean;
+        stationControlRoom: boolean;
+        manageStationPermissions: boolean;
+        viewFacilities: boolean;
+        assignFacilities: boolean;
+        renameFacilities: boolean;
+        makeoverFacilities: boolean;
+        facilityControlRoom: boolean;
+        manageFacilityPermissions: boolean;
+        viewMaterials: boolean;
+        assignMaterials: boolean;
+        renameMaterials: boolean;
+        makeoverMaterials: boolean;
+        viewNpcs: boolean;
+        assignNpcs: boolean;
+        renameNpcs: boolean;
+        makeoverNpcs: boolean;
+        viewCities: boolean;
+        assignCities: boolean;
+        renameCities: boolean;
+        makeoverCities: boolean;
+        manageCityPermissions: boolean;
+        viewCreatures: boolean;
+        assignCreatures: boolean;
+        renameCreatures: boolean;
+        makeoverCreatures: boolean;
+        viewPlanets: boolean;
+        assignPlanets: boolean;
+        viewStocks: boolean;
+        makeoverStocks: boolean;
+        viewDatacards: boolean;
+    };
+};
+
+declare interface CharacterLocation {
+    container?: {
+        type: 'ship' | 'vehicle' | 'station' | 'facility';
+        uid: SwcUid;
+        name: string;
+    };
+    sector?: {
+        uid: SwcUid;
+        name: string;
+    };
+    system?: {
+        uid: SwcUid;
+        name: string;
+    };
+    planet?: {
+        uid: SwcUid;
+        name: string;
+    };
+    city?: {
+        uid: SwcUid;
+        name: string;
+    };
+    coordinates: {
+        galaxy: {
+            x: number | null;
+            y: number | null;
+        };
+        system: {
+            x: number | null;
+            y: number | null;
+        };
+        surface: {
+            x: number | null;
+            y: number | null;
+        };
+        ground: {
+            x: number | null;
+            y: number | null;
+        };
+    };
+}
+
+declare type CharacterResource<TOAuth extends boolean> = TOAuth extends true ? AuthenticatedCharacterResource : PublicCharacterResource;
+
+declare interface CharacterResponse {
+    /** Unique ID referring to this character */
+    uid: SwcUid;
+    /** Character's handle. Always available */
+    name: string;
+    /** Link to the character's avatar. Always available. */
+    image: string;
+    /** The character's current HP. Visible if you have the character_stats scope. */
+    hp?: number;
+    /** The character's maximum HP. Visible if you have the character_stats scope. */
+    maxHp?: number;
+    /** The character's current XP. Visible if you have the character_stats scope. */
+    xp?: number;
+    /** The character's current level. Visible if you have the character_stats scope. */
+    level?: number;
+    /** Whether the character's profile is private. */
+    isProfilePrivate: boolean;
+    /** The character's gender. Visible if their profile is NOT private. */
+    gender?: 'Male' | 'Female';
+    /** The character's biography. Visible if their profile is NOT private. */
+    biography?: string;
+    /** Last login time of this character. Visible if their profile is NOT private. */
+    lastLogin?: SwcTimestamp;
+    /** short description for this character. Visible if their profile is NOT private. */
+    shortDescription?: string;
+    /** The character's race. Visible if their profile is NOT private. */
+    race?: {
+        uid: SwcUid;
+        name: string;
+    };
+    /** Whether the character is aware of the force. Visible if you have the character_force scope. */
+    isForceAware?: boolean;
+    /** The character's factions. Always visible. */
+    factions: Array<CharacterFaction>;
+    /** The character's skill sheet. Visible if you have the character_skills scope. */
+    skills?: CharacterSkills;
+    /** The character's privileges within their factions. Visible if you have the character_privileges scope. */
+    factionPrivileges?: CharacterFactionPrivileges;
+    /** The amount of credits the character has. Visible if you have the character_location scope. */
+    location?: CharacterLocation;
+    /** The amount of credits the character has. Visible if you have the character_credits scope. */
+    credits?: number;
+}
+
+declare interface CharacterSkills {
+    strength: SkillLevel;
+    dexterity: SkillLevel;
+    speed: SkillLevel;
+    dodge: SkillLevel;
+    projectileWeapons: SkillLevel;
+    nonProjectileWeapons: SkillLevel;
+    medical: SkillLevel;
+    diplomacy: SkillLevel;
+    crafting: SkillLevel;
+    management: SkillLevel;
+    perception: SkillLevel;
+    stealth: SkillLevel;
+    rndHull: SkillLevel;
+    rndElectronics: SkillLevel;
+    rndEngines: SkillLevel;
+    rndWeapons: SkillLevel;
+    repair: SkillLevel;
+    computerOperations: SkillLevel;
+    fighterPiloting: SkillLevel;
+    fighterCombat: SkillLevel;
+    capitalPiloting: SkillLevel;
+    capitalCombat: SkillLevel;
+    spaceCommand: SkillLevel;
+    vehiclePiloting: SkillLevel;
+    vehicleCombat: SkillLevel;
+    infantryCommand: SkillLevel;
+    vehicleCommand: SkillLevel;
+    heavyWeapons: SkillLevel;
+}
+
+export declare interface Duration {
+    years: number;
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+}
+
+declare abstract class GenericResource {
+    private resourceName;
+    protected constructor(resourceName: string);
+    protected get<T>(endpointUrl: string, accessToken?: string): Promise<SwcApiResponse<T> | SwcApiError>;
+}
+
+declare interface HandleCheckResult {
+    uid: SwcUid;
+    handle: string;
+}
+
+export declare interface OAuthConfig {
+    clientId: string;
+    clientSecret: string;
+    redirectUri: string;
+    /** Indicates if your application needs to access a Resource when the user is not present at the browser. This parameter defaults to online. If your application needs to refresh access tokens when the user is not present at the browser, then use offline. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user. */
+    accessType: 'online' | 'offline';
+    /** Indicates whether previously granted permissions should be renewed if not explicitly included within the scope parameter. Defaults to not renewing previously granted permissions. **/
+    renewPreviouslyGranted?: boolean;
+    /** Indicates the resource access your application is requesting. The values passed in this parameter inform the consent page shown to the user. There is an inverse relationship between the number of permissions requested and the likelihood of obtaining user consent */
+    defaultScopes?: string[];
+}
+
+declare interface Permission {
+    name: string;
+    description: string;
+    inheritedPermissions: Permission[];
+}
+
+/**
+ *
+ * @method getPermissions
+ */
+declare class PublicApiResource extends GenericResource {
+    constructor();
+    /**
+     * Get a list of all permissions in the SWC webservices.
+     */
+    getPermissions(): Promise<Permission[]>;
+}
+
+declare class PublicCharacterResource extends GenericResource {
+    constructor();
+    handleCheck(handle: string): Promise<HandleCheckResult | undefined>;
+}
+
+declare type SkillLevel = 0 | 1 | 2 | 3 | 4 | 5;
+
+declare type SwcApiError = SwcApiResponse<{
+    error_code: number;
+    error_message: string;
+}>;
+
+declare interface SwcApiResponse<T> {
+    version: string;
+    timestamp: number;
+    resource: string;
+    request: string;
+    swcapi: T;
+}
+
+export declare class SwcClient<TOAuth extends boolean> {
+    api: PublicApiResource;
+    character: CharacterResource<TOAuth>;
+    protected constructor();
+    static public(): SwcClient<false>;
+    static withOAuth(oAuthConfig: OAuthConfig): SwcClientWithOAuth;
+}
+
+export declare class SwcClientWithOAuth extends SwcClient<true> {
+    auth: AuthService;
+    constructor(config: OAuthConfig);
+}
+
+/**
+ * Utility class for working with Star Wars Combine timestamps. Represents Combine  Galactic Time and can convert unix timestamps and Date objects to/from CGT.
+ * @method toUnixTimestamp
+ * @method toDate
+ * @method getYear
+ * @method getDay
+ * @method getHour
+ * @method getMinute
+ * @method getSecond
+ */
+export declare class SwcTimestamp {
+    private static swcStart;
+    protected year: number;
+    protected day: number;
+    protected hour: number;
+    protected minute: number;
+    protected second: number;
+    /**
+     * Create a new SwcTimestamp object for a specific moment in Combine Galactic Time.
+     * @param {TimestampMoment} source
+     */
+    constructor(source: TimestampMoment);
+    /**
+     * Convert a unix timestamp to Combine Galactic Time.
+     * @param {number} unixTimestamp timestamp to convert. Can be either seconds or milliseconds, the code will detect which units to use.
+     * @returns {SwcTimestamp}
+     */
+    static fromUnixTimestamp(unixTimestamp: number): SwcTimestamp;
+    /**
+     * Convert a Date object into Combine Galactic Time.
+     * @param {Date} date
+     * @returns {SwcTimestamp}
+     */
+    static fromDate(date: Date): SwcTimestamp;
+    /**
+     * Get the current Combine Galactic Time.
+     * @returns {SwcTimestamp}
+     */
+    static now(): SwcTimestamp;
+    /**
+     *
+     * @param {number} msSinceSwcStart
+     * @returns {SwcTimestamp}
+     * @private
+     */
+    private static calculateSwcTimestampFromMillisecondsSinceStart;
+    /**
+     * Convert the SWC timestamp into a unix timestamp
+     * @param {'sec' | 'ms' | 'seconds' | 'milliseconds'} unit Whether the unix timestamp should be in seconds or milliseconds.
+     * @returns {number}
+     */
+    toUnixTimestamp(unit: 'sec' | 'ms' | 'seconds' | 'milliseconds'): number;
+    /**
+     * Convert the SWC timestamp into a Date object.
+     * @returns {Date}
+     */
+    toDate(): Date;
+    asMoment(): TimestampMoment;
+    /**
+     * @returns {number}
+     */
+    getYear(): number;
+    /**
+     * @returns {number}
+     */
+    getDay(): number;
+    /**
+     * @returns {number}
+     */
+    getHour(): number;
+    /**
+     * @returns {number}
+     */
+    getMinute(): number;
+    /**
+     * @returns {number}
+     */
+    getSecond(): number;
+    /**
+     * Calculate a new timestamp by adding time to this timestamp, and return the newly calculated timestamp.
+     * @param duration
+     */
+    add(duration: Partial<Duration>): SwcTimestamp;
+    /**
+     * Calculate a new timestamp by subtracting time from this timestamp, and return the newly calculated timestamp.
+     * @param duration
+     */
+    subtract(duration: Partial<Duration>): SwcTimestamp;
+    getDurationTo(otherTimestamp: SwcTimestamp): Duration;
+    /**
+     * @returns {number}
+     * @private
+     */
+    private calculateMillisecondsSinceStartFromSwcTimestamp;
+}
+
+declare class SwcUid {
+    private readonly _entityType;
+    private readonly _id;
+    constructor(entityType: SwcUidType, id: number);
+    constructor(uid: string);
+    get entityType(): SwcUidType;
+    get id(): number;
+    get uid(): string;
+}
+
+declare enum SwcUidType {
+    character = 1,
+    ship = 2,
+    vehicle = 3,
+    facility = 4,
+    station = 5,
+    city = 7,
+    planet = 8,
+    system = 9,
+    npc = 10,
+    creature = 11,
+    item = 12,
+    droid = 13,
+    datacard = 14,
+    material = 16,
+    stock = 17,
+    weapon = 18,
+    faction = 20,
+    race = 22,
+    sector = 25,
+    customImage = 37
+}
+
+export declare interface TimestampMoment {
+    year: number;
+    day: number;
+    hour?: number;
+    minute?: number;
+    second?: number;
+}
+
+export declare interface TokenInfo {
+    accessToken: string;
+    refreshToken?: string;
+    expiryTime: Date;
+}
+
+export { }