Latest
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268import type { ETradeOfferState } from "./enums/ETradeOfferState.ts";import { CryptStorage } from "./crypt_storage.ts";import { DataPoller, DataPollerOptions, PollData } from "./data_poller.ts";import { SteamApi } from "./steam_api/mod.ts";import { LoginOptions, SteamCommunity, SteamCommunityOptions,} from "./steam_community.ts";import { Evt, getLanguageInfo, SteamID, to } from "../deps.ts";import type { CookieOptions } from "../deps.ts";import { Storage } from "./storage.ts";import { SteamUser } from "./steam_user.ts";import { TradeOffer } from "./trade_offer.ts";
export type TradeManagerOptions = { /** default: 'localhost' */ domain?: string; /** default: 'en' */ language?: string; /** If `true`, all EconItems will have descriptions before passed around. * * Setting this to `false` (default) decreases api calls when you don't care about the items' descriptions. */ getDescriptions?: boolean; communityOptions?: Omit<SteamCommunityOptions, "languageName" | "manager">; pollingOptions?: Omit<DataPollerOptions, "manager">; /** not implemented. do **NOT** use. */ useProtobuf?: boolean; /** The time, in milliseconds, that a sent offer can remain Active until it's automatically canceled by the manager. * This feature is disabled if omitted. * * Note that this check is performed on polling, so it will only work as expected if timed polling is enabled. * Also note that because polling is on a timer, * offers will be canceled between `cancelTime` and `cancelTime + pollInterval` milliseconds after being created, * assuming Steam is up. */ cancelTime?: number; /** Optional. The time, in milliseconds, that a sent offer can remain CreatedNeedsConfirmation until * it's automatically canceled by the manager. * This feature is disabled if omitted. All documentation for cancelTime applies. */ pendingCancelTime?: number; /** Optional. Once we have this many outgoing Active offers, the oldest will be automatically canceled. */ cancelOfferCount?: number; /** Optional. If you're using cancelOfferCount, then offers must be at least this many milliseconds old in order to qualify for automatic cancellation. */ cancelOfferCountMinAge?: number;};
export class TradeManager { language: string; languageName: string; domain: string; steamCommunity: SteamCommunity; steamApi: SteamApi; dataPoller: DataPoller; private steamUser: SteamUser | undefined; getDescriptions: boolean; pendingSendOffersCount: number; cancelTime: number | undefined; pendingCancelTime: number | undefined; cancelOfferCount: number | undefined; cancelOfferCountMinAge: number | undefined; evt = new Evt< | ["sessionExpired", Error] | ["familyViewRestricted", Error] | ["newOffer", TradeOffer] | ["realTimeTradeConfirmationRequired", TradeOffer] | ["realTimeTradeCompleted", TradeOffer] | ["receivedOfferChanged", [TradeOffer, ETradeOfferState]] | ["unknownOfferSent", TradeOffer] | ["sentOfferChanged", [TradeOffer, ETradeOfferState]] | ["sentOfferCanceled", [TradeOffer, string]] | ["sentPendingOfferCanceled", TradeOffer] | ["pollSuccess", undefined] | ["pollFailure", Error] | ["debug", unknown] >();
constructor(options: TradeManagerOptions) { const { domain = "localhost", language = "en", communityOptions, pollingOptions, useProtobuf, getDescriptions = false, cancelTime, pendingCancelTime, cancelOfferCount, cancelOfferCountMinAge, } = options;
this.domain = domain; this.getDescriptions = getDescriptions; this.language = language; this.languageName = ""; this.pendingSendOffersCount = 0; this.cancelTime = cancelTime; this.pendingCancelTime = pendingCancelTime; this.cancelOfferCount = cancelOfferCount; this.cancelOfferCountMinAge = cancelOfferCountMinAge;
if (language) { if (language == "szh") { this.language = "zh"; this.languageName = "schinese"; } else if (this.language == "tzh") { this.language = "zh"; this.languageName = "tchinese"; } else { const lang = getLanguageInfo(this.language); if (!lang || !lang.name) { this.language = ""; } else { this.languageName = lang.name.toLowerCase(); } } }
this.steamCommunity = new SteamCommunity({ manager: this, languageName: this.languageName, ...communityOptions, }); this.steamApi = new SteamApi(); this.dataPoller = new DataPoller({ manager: this, ...pollingOptions, });
if (useProtobuf) { // TODO this.steamUser = new SteamUser(); this.steamUser.evt.$attach(to("tradeOffers"), () => { this.dataPoller.doPoll(); }); this.steamUser.evt.$attach(to("newItems"), () => { this.dataPoller.doPoll(); }); } }
/** returns steamCommunity instance's steamID. undefined unitl successful login */ get steamID() { return this.steamCommunity.steamID; }
get confirmationService() { return this.steamCommunity.confirmationService; }
/** * Logins to steam community, get apikey if not set already and set it for steam api use. may throw errors. * * Only after this function is finished successfully you may start using trade manager */ async setup(options?: LoginOptions) { await this.steamCommunity.login(options); const apikey = await this.steamCommunity.getWebApiKey(this.domain); if (!apikey) throw new Error("apikey invalid"); this.steamApi.setApiKey(apikey); this.dataPoller.start(); }
async shutdown() { // TODO await this.dataPoller.stop(); }
/** * * @param partner - Either a trade url or a string that can be parsed to a steam id * @param token - The trade token. optional. */ createOffer(partner: string | SteamID, token?: string) { let partnerSteamID; let tokenStr = token; if (typeof partner === "string" && /^https?:\/\//.test(partner)) { try { const url = new URL(partner); const partnerParam = url.searchParams.get("partner"); const tokenParam = url.searchParams.get("token"); if (!partnerParam) { throw new Error("Invalid trade URL"); } partnerSteamID = SteamID.fromIndividualAccountID(partnerParam); tokenStr = tokenParam || tokenStr; } catch (err) { throw err; } }
if (!partnerSteamID) { throw new Error("Invalid partner ID"); }
const offer = new TradeOffer(this, partnerSteamID, tokenStr); offer.isOurOffer = true; offer.fromRealTimeTrade = false; return offer; }
loadOffer(offerid: string) { return TradeOffer.fromOfferId(this, offerid); }}
/** * Use this helper function to create TradeManager and use some defaults. you must provide username, password and sharedSecret when using this. * otherwise you have to construct a trade manager object and call `manager.setup()` function yourself to start using it. * * using this function automatically saves/loads poll data to/from the disk. * also encrypts your cookies to disk using your machine guid (relogin needed when changing systems). * so it needs following permissions: * * on windows (not sure if syntax is correct): --allow-env --allow-run --allow-read=%cd%\\storage --allow-write=%cd%\\storage --allow-net=api.steampowered.com,steamcommunity.com * * on linux: --allow-read=/var/lib/dbus/machine-id,/etc/machine-id,$PWD/storage --allow-write=$PWD/storage --allow-net=api.steampowered.com,steamcommunity.com * * @param debug - a function to add as event handler of 'debug' early. * currently the only way to debug setup phase through this function. */export async function createTradeManager( options: TradeManagerOptions, debug?: (arg: unknown) => void | Promise<void>,) { const { communityOptions, pollingOptions, ...otherOptions } = options || {}; const tradeManager = new TradeManager({ communityOptions: { loadCookies: (username) => { return CryptStorage.loadData( `comm_cookies_${username}.bin`, ) as Promise< Array< CookieOptions > >; }, // our cookie jar supports json serialization directly saveCookies: async (data, username) => { await CryptStorage.saveData(`comm_cookies_${username}.bin`, data); }, ...communityOptions, }, pollingOptions: { loadPollData: (username) => { return Storage.loadData(`poll_data_${username}.json`) as Promise< PollData >; }, savePollData: async (data, username) => { await Storage.saveData(`poll_data_${username}.json`, data); }, ...pollingOptions, }, ...otherOptions, }); if (debug) { tradeManager.evt.$attach(to("debug"), debug); } await tradeManager.setup(); return tradeManager;}