mirror of
https://gitea.tendokyu.moe/ppc/amnet.git
synced 2026-10-05 13:17:59 +03:00
36 lines
1.3 KiB
TypeScript
36 lines
1.3 KiB
TypeScript
/**
|
|
* The latest version of the AMNet API this library supports
|
|
*/
|
|
declare const AMNET_API_VERSION = 1;
|
|
interface AMCardInRequest {
|
|
cardId: string;
|
|
}
|
|
interface AMServerInfoResponse {
|
|
serverAddress: string;
|
|
serverName: string;
|
|
apiVersion: number;
|
|
}
|
|
/**
|
|
* Performs the card-in request to the specified server
|
|
* @param serverAddress The origin address of the server to perform the request against
|
|
* @param request The card-in request to send
|
|
* @param signal The abort signal to use for the request
|
|
*/
|
|
declare function performCardIn(serverAddress: string, request: AMCardInRequest, signal: AbortSignal): Promise<boolean>;
|
|
/**
|
|
* Attempts to connect to the specified server and fetch its info
|
|
* @param serverAddress The origin address of the server to connect to
|
|
* @param abort The abort signal to use for the request (for cancellation)
|
|
*/
|
|
declare function fetchServerInfo(serverAddress: string, abort: AbortSignal): Promise<AMServerInfoResponse | null>;
|
|
|
|
declare const CARD_ID_REGEX: RegExp;
|
|
declare function generateCardNumber(): string;
|
|
/**
|
|
* Validates the provided card id by known parameters
|
|
* @param id The card id to validate
|
|
*/
|
|
declare function validateCardId(id: string): boolean;
|
|
|
|
export { type AMCardInRequest, AMNET_API_VERSION, type AMServerInfoResponse, CARD_ID_REGEX, fetchServerInfo, generateCardNumber, performCardIn, validateCardId };
|