virtualizorjs 1.0.5 → 2.1.0

package/dist/index.d.mts

@@ -0,0 +1,383 @@
+interface VirtualizorError {
+    code: number;
+    msg: string;
+}
+interface VirtualizorResponse {
+    title?: string;
+    timenow?: number;
+    time_taken?: string;
+    error?: VirtualizorError[];
+}
+interface AsyncTaskResult extends VirtualizorResponse {
+    done?: 1;
+    taskid?: string;
+}
+type VirtType = 'kvm' | 'xen' | 'openvz' | 'lxc' | 'proxmox' | 'virtuozzo' | 'xcp' | 'hyperv';
+
+interface VirtualizorConfig {
+    host: string;
+    apiKey: string;
+    apiPass?: string;
+    port?: number;
+    https?: boolean;
+    rejectUnauthorized?: boolean;
+    timeout?: number;
+}
+interface ResolvedConfig {
+    host: string;
+    apiKey: string;
+    apiPass: string;
+    port: number;
+    https: boolean;
+    rejectUnauthorized: boolean;
+    timeout: number;
+}
+
+declare class VirtualizorApiError extends Error {
+    readonly code: number;
+    constructor(message: string, code: number);
+}
+type Params = Record<string, string | number | undefined>;
+declare class HttpClient {
+    private readonly config;
+    constructor(config: ResolvedConfig);
+    parseResponse<T extends VirtualizorResponse>(data: T): T;
+    request<T extends VirtualizorResponse>(act: string, queryParams?: Params, bodyParams?: Params): Promise<T>;
+    private rawRequest;
+}
+
+interface Plan {
+    pid: string;
+    plan_name: string;
+    disk: string;
+    ram: string;
+    bandwidth: string;
+    cpu: string;
+    virt?: string;
+}
+interface CreatePlanParams {
+    plan_name: string;
+    disk: number;
+    ram: number;
+    bandwidth: number;
+    cpu: number;
+    virt?: string;
+}
+
+declare class PlansResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<Record<string, Plan>>;
+    create(params: CreatePlanParams): Promise<AsyncTaskResult>;
+    delete(planId: string): Promise<AsyncTaskResult>;
+}
+
+interface Task {
+    id: string;
+    action: string;
+    status: string;
+    vpsid?: string;
+    data?: unknown;
+}
+
+declare class TasksResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    get(taskId: string): Promise<Task | undefined>;
+    wait(taskId: string, options?: {
+        pollIntervalMs?: number;
+        timeoutMs?: number;
+    }): Promise<Task>;
+}
+
+interface User {
+    uid: string;
+    email: string;
+    fname?: string;
+    lname?: string;
+    status: string;
+    type: string;
+}
+interface CreateUserParams {
+    email: string;
+    password: string;
+    fname?: string;
+    lname?: string;
+    acttype?: number;
+}
+
+declare class UsersResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<Record<string, User>>;
+    create(params: CreateUserParams): Promise<AsyncTaskResult>;
+    delete(uid: string): Promise<AsyncTaskResult>;
+    suspend(uid: string): Promise<AsyncTaskResult>;
+    unsuspend(uid: string): Promise<AsyncTaskResult>;
+}
+
+interface VPSData {
+    os_type?: number | string;
+    rtc?: number | string;
+    unprivileged?: number | string;
+    vnc_auto_port?: number | string;
+    nested_virt?: number | string;
+    vga_vram?: number | string;
+    discard?: number | string;
+    vlan_tag?: number | string;
+    enable_guest_agent?: number | string;
+    ssd_emulation?: number | string;
+    machine_type?: number | string;
+    bios?: string;
+    enable_tpm?: number | string;
+    disable_password?: string;
+    ssh_options?: string;
+    added_keys?: unknown[];
+    io_uring?: number | string;
+    min_ram?: number | string;
+    vga?: number | string;
+    vga_memory?: number | string;
+    cpu_flags?: number | string;
+    scsi_controller?: number | string;
+    demo?: string | null;
+    enable_cpu_threshold?: number | string;
+    cpu_threshold?: number | string;
+    cpu_threshold_time?: number | string;
+    disable_guest_agent?: number | string;
+    disable_autostart?: number | string;
+    iothread?: number | string;
+    nesting?: number | string;
+    suspended_time?: number | string;
+    multiqueue?: number | string;
+    freeze_fs_on_backup?: number | string;
+    enable_ver_scaling?: number | string;
+    ver_max_ram?: string | number;
+    ver_ram_threshold?: string | number;
+    ver_ram_inc_by?: string | number;
+    ver_max_cpu?: string | number;
+    ver_cpu_threshold?: string | number;
+    ver_cpu_inc_by?: string | number;
+    random_ipv6?: number | string;
+    encrypted_pass?: number | string;
+    vm_admin_name?: string;
+    crypted_pass?: string | null;
+    crypted_salt?: string | null;
+    custom_ipv6_on_edit?: number | string;
+    docker_info?: unknown | null;
+}
+interface VPS {
+    vpsid: string;
+    vps_name?: string;
+    uuid?: string;
+    serid?: string | number;
+    time?: string | number;
+    edittime?: string | number;
+    virt?: VirtType | string;
+    uid?: string | number;
+    plid?: string | number;
+    hostname: string;
+    osid?: string | number;
+    os_name: string;
+    iso?: string;
+    sec_iso?: string;
+    boot?: string;
+    space?: string | number;
+    inodes?: string | number;
+    ram: string;
+    burst?: string | number;
+    swap?: string | number;
+    cpu?: string | number;
+    cores?: string | number;
+    cpupin?: string | number;
+    cpu_percent?: string | number;
+    bandwidth: string;
+    network_speed?: string | number;
+    upload_speed?: string | number;
+    io?: string | number;
+    ubc?: string;
+    acpi?: string | number;
+    apic?: string | number;
+    pae?: string | number;
+    shadow?: string | number;
+    vnc?: string | number;
+    vncport?: string | number;
+    vnc_passwd?: string;
+    hvm?: string | number;
+    suspended?: string | number;
+    suspend_reason?: string | null;
+    nw_suspended?: string | null;
+    rescue?: string | number;
+    band_suspend?: string | number;
+    tuntap?: string | number;
+    ppp?: string | number;
+    ploop?: string | number;
+    dns_nameserver?: string;
+    osreinstall_limit?: string | number;
+    preferences?: unknown | null;
+    nic_type?: string;
+    vif_type?: string;
+    virtio?: string | number;
+    pv_on_hvm?: string | number;
+    disks?: unknown | null;
+    kvm_cache?: string | number;
+    io_mode?: string | number;
+    cpu_mode?: string;
+    total_iops_sec?: string | number;
+    read_bytes_sec?: string | number;
+    write_bytes_sec?: string | number;
+    kvm_vga?: string | number;
+    acceleration?: string | number;
+    vnc_keymap?: string;
+    routing?: string | number;
+    mg?: string;
+    used_bandwidth?: string | number;
+    cached_disk?: unknown;
+    webuzo?: string | number;
+    disable_ebtables?: string | number;
+    install_xentools?: string | number;
+    admin_managed?: string | number;
+    rdp?: string | number;
+    topology_sockets?: string | number;
+    topology_cores?: string | number;
+    topology_threads?: string | number;
+    mac?: string;
+    notes?: string | null;
+    disable_nw_config?: string | number;
+    locked?: string;
+    openvz_features?: string;
+    speed_cap?: string;
+    numa?: string | number;
+    bpid?: string | number;
+    bserid?: string | number;
+    timezone?: string | null;
+    ha?: string | number;
+    load_balancer?: string | number;
+    data?: VPSData;
+    fwid?: string | number;
+    admin_fwid?: string | number;
+    current_resource?: unknown | null;
+    plan_expiry?: string | number;
+    machine_status?: string | number;
+    tags?: string | null;
+    server_name?: string;
+    email?: string;
+    pid?: string | number;
+    type?: string | number;
+    os_distro?: string;
+    stid?: number[];
+    ips?: Record<string, string>;
+}
+interface ListVPSParams {
+    user?: string | number;
+    vpsid?: string | number;
+    vpsname?: string;
+    vpsip?: string;
+    vpshostname?: string;
+    vsstatus?: string;
+    vstype?: VirtType;
+    serid?: number;
+    plid?: number;
+    bpid?: number;
+}
+interface CreateVPSParams {
+    hostname: string;
+    rootpass: string;
+    osid: number;
+    plid?: number;
+    user_email?: string;
+    ips?: number;
+    ips_int?: number;
+    space?: number;
+    ram?: number;
+    burst?: number;
+    bandwidth?: number;
+    cpu?: number;
+    cpu_percent?: number;
+    virt?: VirtType;
+    serid?: number;
+    node_select?: 0 | 1;
+    recipe?: number;
+    sshkey?: string;
+    nopassword?: 0 | 1;
+}
+interface RebuildVPSParams {
+    /** OS template ID to rebuild with */
+    osid: number;
+    /** New root password for the VPS */
+    newpass: string;
+    /** Must be set to 1 to confirm the rebuild */
+    conf: 1;
+    /** Format primary disk (0 = no, 1 = yes); defaults to 0 */
+    format_primary?: 0 | 1;
+    /** Send rebuild notification email (0 = no, 1 = yes) */
+    eu_send_rebuild_email?: 0 | 1;
+    /** Recipe ID to apply post-rebuild */
+    recipe?: number;
+    /** SSH key to inject */
+    sshkey?: string;
+}
+interface CloneVPSParams {
+    /** Hostname for the new cloned VPS */
+    hostname: string;
+    /** Root password for the new cloned VPS */
+    rootpass: string;
+    /** Source server ID (server where the VPS lives) */
+    from_server: number;
+    /** Destination server ID (server to clone into) */
+    to_server: number;
+}
+interface MigrateVPSParams {
+    /** Destination server ID */
+    serid: number;
+    /** Source server IP address */
+    from_ip: string;
+    /** Source server API/root password */
+    from_pass: string;
+    /** 0 = ignore VDF conflicts, 1 = error on conflict */
+    ignore_if_vdfconflict?: 0 | 1;
+    /** 0 = use gzip compression, 1 = disable gzip */
+    disable_gzip?: 0 | 1;
+    /** 0 = offline migration, 1 = live migration */
+    online?: 0 | 1;
+}
+interface VPSStatsResponse extends VirtualizorResponse {
+    vs_stats?: unknown;
+    vs_bandwidth?: unknown;
+    time_taken?: string;
+}
+interface VNCInfo extends VirtualizorResponse {
+    novnc?: string;
+    [key: string]: unknown;
+}
+
+declare class VpsResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(filters?: ListVPSParams): Promise<Record<string, VPS>>;
+    get(vpsId: string): Promise<VPS>;
+    create(params: CreateVPSParams): Promise<AsyncTaskResult>;
+    delete(vpsId: string): Promise<AsyncTaskResult>;
+    start(vpsId: string): Promise<AsyncTaskResult>;
+    stop(vpsId: string): Promise<AsyncTaskResult>;
+    restart(vpsId: string): Promise<AsyncTaskResult>;
+    poweroff(vpsId: string): Promise<AsyncTaskResult>;
+    suspend(vpsId: string): Promise<AsyncTaskResult>;
+    unsuspend(vpsId: string): Promise<AsyncTaskResult>;
+    rebuild(vpsId: string, params: RebuildVPSParams): Promise<AsyncTaskResult>;
+    clone(vpsId: string, params: CloneVPSParams): Promise<AsyncTaskResult>;
+    migrate(vpsId: string, params: MigrateVPSParams): Promise<AsyncTaskResult>;
+    status(vpsId: string): Promise<unknown>;
+    vnc(vpsId: string): Promise<VNCInfo>;
+    stats(vpsId: string): Promise<VPSStatsResponse>;
+}
+
+declare class VirtualizorClient {
+    readonly vps: VpsResource;
+    readonly users: UsersResource;
+    readonly plans: PlansResource;
+    readonly tasks: TasksResource;
+    constructor(config: VirtualizorConfig);
+}
+declare function createVirtualizorClient(config: VirtualizorConfig): VirtualizorClient;
+
+export { type AsyncTaskResult, type CloneVPSParams, type CreatePlanParams, type CreateUserParams, type CreateVPSParams, type ListVPSParams, type MigrateVPSParams, type Plan, type RebuildVPSParams, type Task, type User, type VPS, type VirtType, VirtualizorApiError, VirtualizorClient, type VirtualizorConfig, createVirtualizorClient };