@roxyon/api-client 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -364,6 +364,49 @@ declare class AuthApi {
     logout(): Promise<void>;
 }
 
+interface CreateDatabaseInput {
+    /** DB name suffix — the platform prefixes it with the subscription's own username (globally unique). */
+    name: string;
+    /** Subscription to attach it to. Omit when the account has exactly one. */
+    subscription?: string;
+    /** Omit to have the platform generate one. */
+    password?: string;
+}
+interface CreateDatabaseResult {
+    ok: boolean;
+    objectId: string;
+    name: string;
+    username: string;
+    /** Shown once — not retrievable afterwards. */
+    password?: string;
+    /** `<node-ip>:6033` — the ProxySQL endpoint to connect the app to. */
+    host?: string;
+    status: 'provisioning' | 'active' | 'failed';
+    error?: string;
+}
+interface DatabaseSummary {
+    objectId: string;
+    Name: string;
+    Username: string;
+    Status: string;
+}
+interface DeleteDatabaseResult {
+    ok: boolean;
+    objectId: string;
+    status: 'deleting' | 'deleted' | 'failed';
+    error?: string;
+}
+/** Databases (MySQL/MariaDB on the shared Galera cluster) attached to a subscription. */
+declare class DatabasesApi {
+    private readonly client;
+    constructor(client: RoxyonClient);
+    list(subscriptionId: string): Promise<DatabaseSummary[]>;
+    /** `POST /databases/create` — provision a database + user; the reconciler does the rest. */
+    create(input: CreateDatabaseInput): Promise<CreateDatabaseResult>;
+    /** `POST /databases/delete` */
+    delete(databaseId: string): Promise<DeleteDatabaseResult>;
+}
+
 interface Domain {
     objectId: string;
     Name: string;
@@ -375,6 +418,8 @@ interface CreateDomainInput {
     subscription?: string;
     /** `spa` → unmatched paths serve `/index.html`; default `static`. */
     siteType?: 'static' | 'spa';
+    /** PHP version for the vhost (e.g. `"8.3"`). Unknown/omitted falls back to the platform default. */
+    phpVersion?: string;
 }
 interface CreateDomainResult {
     ok: boolean;
@@ -399,6 +444,52 @@ declare class DomainsApi {
     create(input: CreateDomainInput): Promise<CreateDomainResult>;
 }
 
+interface CreateEmailInput {
+    /** The part before `@`. */
+    localPart: string;
+    /** A hostname already on the account. */
+    domain: string;
+    /** Omit to have the platform generate one. */
+    password?: string;
+    /** Mailbox quota in MB. Default 1024. */
+    quota?: number;
+    forwardTo?: string;
+    saveCopy?: boolean;
+}
+interface CreateEmailResult {
+    ok: boolean;
+    objectId: string;
+    email: string;
+    /** Shown once — not retrievable afterwards. */
+    password?: string;
+    quota?: number;
+    status: 'provisioning' | 'active' | 'failed';
+    error?: string;
+}
+interface EmailSummary {
+    objectId: string;
+    Email: string;
+    LocalPart: string;
+    Status: string;
+    Quota?: number;
+}
+interface DeleteEmailResult {
+    ok: boolean;
+    objectId: string;
+    status: 'deleting' | 'deleted' | 'failed';
+    error?: string;
+}
+/** Mailboxes attached to a subscription's domains. */
+declare class EmailApi {
+    private readonly client;
+    constructor(client: RoxyonClient);
+    list(subscriptionId: string): Promise<EmailSummary[]>;
+    /** `POST /emails/create` — provision a mailbox; the reconciler does the rest. */
+    create(input: CreateEmailInput): Promise<CreateEmailResult>;
+    /** `POST /emails/delete` */
+    delete(emailId: string): Promise<DeleteEmailResult>;
+}
+
 interface StaticDeployResult {
     ok: boolean;
     host: string;
@@ -442,6 +533,30 @@ declare class SitesApi {
     readFile(host: string, folder: string, path: string): Promise<SiteFileContent>;
 }
 
+interface ResetSshPasswordInput {
+    /** Subscription to reset. Omit when the account has exactly one. */
+    subscription?: string;
+    /** Omit to have the platform generate one meeting the strength rules. */
+    password?: string;
+}
+interface ResetSshPasswordResult {
+    ok: boolean;
+    subscription: string;
+    /** Shown once — the platform never stores or re-shows it. */
+    password: string;
+    status: 'pending' | 'active' | 'failed';
+}
+/**
+ * The shared shell password used for SSH, SFTP and the file manager on a
+ * subscription's container (SSHpiper maps the username to the container).
+ */
+declare class SshApi {
+    private readonly client;
+    constructor(client: RoxyonClient);
+    /** `POST /ssh/password` */
+    resetPassword(input?: ResetSshPasswordInput): Promise<ResetSshPasswordResult>;
+}
+
 interface Subscription {
     objectId: string;
     Name?: string;
@@ -577,8 +692,11 @@ declare class Roxyon {
     readonly domains: DomainsApi;
     readonly applications: ApplicationsApi;
     readonly sites: SitesApi;
+    readonly databases: DatabasesApi;
+    readonly email: EmailApi;
+    readonly ssh: SshApi;
     constructor(options?: RoxyonClientOptions | RoxyonClient);
     get sessionToken(): string | undefined;
 }
 
-export { AccountApi, type AccountApp, type AccountContext, type AccountDomain, type AccountSubscription, type Application, type ApplicationProcess, type ApplicationRoute, ApplicationsApi, AuthApi, type CreateApplicationInput, type CreateDomainInput, type CreateDomainResult, type CreateOnDeploy, type CreatedToken, DEFAULT_APP, DEFAULT_BAAS_URL, DEFAULT_CONSOLE_URL, type DeployKind, type DeployOptions, type DeployResult, type Domain, DomainsApi, LUMEN_BUILD, type LoginPrecheck, type LoginResult, type Privilege, RUNTIMES, type RequestOptions, Roxyon, RoxyonApiError, RoxyonClient, type RoxyonClientOptions, type RoxyonUser, type RuntimeName, type RuntimeSpec, type SessionGrant, type SiteFile, type SiteFileContent, SitesApi, type StaticDeployResult, type Subscription, SubscriptionsApi, type TokenScope, type TokenSummary, TokensApi, assertOk, envFromStored, formatEnv, isAuthError, parseEnv, rxError, toQueryString };
+export { AccountApi, type AccountApp, type AccountContext, type AccountDomain, type AccountSubscription, type Application, type ApplicationProcess, type ApplicationRoute, ApplicationsApi, AuthApi, type CreateApplicationInput, type CreateDatabaseInput, type CreateDatabaseResult, type CreateDomainInput, type CreateDomainResult, type CreateEmailInput, type CreateEmailResult, type CreateOnDeploy, type CreatedToken, DEFAULT_APP, DEFAULT_BAAS_URL, DEFAULT_CONSOLE_URL, type DatabaseSummary, DatabasesApi, type DeleteDatabaseResult, type DeleteEmailResult, type DeployKind, type DeployOptions, type DeployResult, type Domain, DomainsApi, EmailApi, type EmailSummary, LUMEN_BUILD, type LoginPrecheck, type LoginResult, type Privilege, RUNTIMES, type RequestOptions, type ResetSshPasswordInput, type ResetSshPasswordResult, Roxyon, RoxyonApiError, RoxyonClient, type RoxyonClientOptions, type RoxyonUser, type RuntimeName, type RuntimeSpec, type SessionGrant, type SiteFile, type SiteFileContent, SitesApi, SshApi, type StaticDeployResult, type Subscription, SubscriptionsApi, type TokenScope, type TokenSummary, TokensApi, assertOk, envFromStored, formatEnv, isAuthError, parseEnv, rxError, toQueryString };

package/dist/index.d.ts

@@ -364,6 +364,49 @@ declare class AuthApi {
     logout(): Promise<void>;
 }
 
+interface CreateDatabaseInput {
+    /** DB name suffix — the platform prefixes it with the subscription's own username (globally unique). */
+    name: string;
+    /** Subscription to attach it to. Omit when the account has exactly one. */
+    subscription?: string;
+    /** Omit to have the platform generate one. */
+    password?: string;
+}
+interface CreateDatabaseResult {
+    ok: boolean;
+    objectId: string;
+    name: string;
+    username: string;
+    /** Shown once — not retrievable afterwards. */
+    password?: string;
+    /** `<node-ip>:6033` — the ProxySQL endpoint to connect the app to. */
+    host?: string;
+    status: 'provisioning' | 'active' | 'failed';
+    error?: string;
+}
+interface DatabaseSummary {
+    objectId: string;
+    Name: string;
+    Username: string;
+    Status: string;
+}
+interface DeleteDatabaseResult {
+    ok: boolean;
+    objectId: string;
+    status: 'deleting' | 'deleted' | 'failed';
+    error?: string;
+}
+/** Databases (MySQL/MariaDB on the shared Galera cluster) attached to a subscription. */
+declare class DatabasesApi {
+    private readonly client;
+    constructor(client: RoxyonClient);
+    list(subscriptionId: string): Promise<DatabaseSummary[]>;
+    /** `POST /databases/create` — provision a database + user; the reconciler does the rest. */
+    create(input: CreateDatabaseInput): Promise<CreateDatabaseResult>;
+    /** `POST /databases/delete` */
+    delete(databaseId: string): Promise<DeleteDatabaseResult>;
+}
+
 interface Domain {
     objectId: string;
     Name: string;
@@ -375,6 +418,8 @@ interface CreateDomainInput {
     subscription?: string;
     /** `spa` → unmatched paths serve `/index.html`; default `static`. */
     siteType?: 'static' | 'spa';
+    /** PHP version for the vhost (e.g. `"8.3"`). Unknown/omitted falls back to the platform default. */
+    phpVersion?: string;
 }
 interface CreateDomainResult {
     ok: boolean;
@@ -399,6 +444,52 @@ declare class DomainsApi {
     create(input: CreateDomainInput): Promise<CreateDomainResult>;
 }
 
+interface CreateEmailInput {
+    /** The part before `@`. */
+    localPart: string;
+    /** A hostname already on the account. */
+    domain: string;
+    /** Omit to have the platform generate one. */
+    password?: string;
+    /** Mailbox quota in MB. Default 1024. */
+    quota?: number;
+    forwardTo?: string;
+    saveCopy?: boolean;
+}
+interface CreateEmailResult {
+    ok: boolean;
+    objectId: string;
+    email: string;
+    /** Shown once — not retrievable afterwards. */
+    password?: string;
+    quota?: number;
+    status: 'provisioning' | 'active' | 'failed';
+    error?: string;
+}
+interface EmailSummary {
+    objectId: string;
+    Email: string;
+    LocalPart: string;
+    Status: string;
+    Quota?: number;
+}
+interface DeleteEmailResult {
+    ok: boolean;
+    objectId: string;
+    status: 'deleting' | 'deleted' | 'failed';
+    error?: string;
+}
+/** Mailboxes attached to a subscription's domains. */
+declare class EmailApi {
+    private readonly client;
+    constructor(client: RoxyonClient);
+    list(subscriptionId: string): Promise<EmailSummary[]>;
+    /** `POST /emails/create` — provision a mailbox; the reconciler does the rest. */
+    create(input: CreateEmailInput): Promise<CreateEmailResult>;
+    /** `POST /emails/delete` */
+    delete(emailId: string): Promise<DeleteEmailResult>;
+}
+
 interface StaticDeployResult {
     ok: boolean;
     host: string;
@@ -442,6 +533,30 @@ declare class SitesApi {
     readFile(host: string, folder: string, path: string): Promise<SiteFileContent>;
 }
 
+interface ResetSshPasswordInput {
+    /** Subscription to reset. Omit when the account has exactly one. */
+    subscription?: string;
+    /** Omit to have the platform generate one meeting the strength rules. */
+    password?: string;
+}
+interface ResetSshPasswordResult {
+    ok: boolean;
+    subscription: string;
+    /** Shown once — the platform never stores or re-shows it. */
+    password: string;
+    status: 'pending' | 'active' | 'failed';
+}
+/**
+ * The shared shell password used for SSH, SFTP and the file manager on a
+ * subscription's container (SSHpiper maps the username to the container).
+ */
+declare class SshApi {
+    private readonly client;
+    constructor(client: RoxyonClient);
+    /** `POST /ssh/password` */
+    resetPassword(input?: ResetSshPasswordInput): Promise<ResetSshPasswordResult>;
+}
+
 interface Subscription {
     objectId: string;
     Name?: string;
@@ -577,8 +692,11 @@ declare class Roxyon {
     readonly domains: DomainsApi;
     readonly applications: ApplicationsApi;
     readonly sites: SitesApi;
+    readonly databases: DatabasesApi;
+    readonly email: EmailApi;
+    readonly ssh: SshApi;
     constructor(options?: RoxyonClientOptions | RoxyonClient);
     get sessionToken(): string | undefined;
 }
 
-export { AccountApi, type AccountApp, type AccountContext, type AccountDomain, type AccountSubscription, type Application, type ApplicationProcess, type ApplicationRoute, ApplicationsApi, AuthApi, type CreateApplicationInput, type CreateDomainInput, type CreateDomainResult, type CreateOnDeploy, type CreatedToken, DEFAULT_APP, DEFAULT_BAAS_URL, DEFAULT_CONSOLE_URL, type DeployKind, type DeployOptions, type DeployResult, type Domain, DomainsApi, LUMEN_BUILD, type LoginPrecheck, type LoginResult, type Privilege, RUNTIMES, type RequestOptions, Roxyon, RoxyonApiError, RoxyonClient, type RoxyonClientOptions, type RoxyonUser, type RuntimeName, type RuntimeSpec, type SessionGrant, type SiteFile, type SiteFileContent, SitesApi, type StaticDeployResult, type Subscription, SubscriptionsApi, type TokenScope, type TokenSummary, TokensApi, assertOk, envFromStored, formatEnv, isAuthError, parseEnv, rxError, toQueryString };
+export { AccountApi, type AccountApp, type AccountContext, type AccountDomain, type AccountSubscription, type Application, type ApplicationProcess, type ApplicationRoute, ApplicationsApi, AuthApi, type CreateApplicationInput, type CreateDatabaseInput, type CreateDatabaseResult, type CreateDomainInput, type CreateDomainResult, type CreateEmailInput, type CreateEmailResult, type CreateOnDeploy, type CreatedToken, DEFAULT_APP, DEFAULT_BAAS_URL, DEFAULT_CONSOLE_URL, type DatabaseSummary, DatabasesApi, type DeleteDatabaseResult, type DeleteEmailResult, type DeployKind, type DeployOptions, type DeployResult, type Domain, DomainsApi, EmailApi, type EmailSummary, LUMEN_BUILD, type LoginPrecheck, type LoginResult, type Privilege, RUNTIMES, type RequestOptions, type ResetSshPasswordInput, type ResetSshPasswordResult, Roxyon, RoxyonApiError, RoxyonClient, type RoxyonClientOptions, type RoxyonUser, type RuntimeName, type RuntimeSpec, type SessionGrant, type SiteFile, type SiteFileContent, SitesApi, SshApi, type StaticDeployResult, type Subscription, SubscriptionsApi, type TokenScope, type TokenSummary, TokensApi, assertOk, envFromStored, formatEnv, isAuthError, parseEnv, rxError, toQueryString };

package/dist/index.js

@@ -575,6 +575,41 @@ var RoxyonClient = class {
   }
 };
 
+// src/databases.ts
+var DatabasesApi = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  async list(subscriptionId) {
+    const r = await this.client.get("/Databases", {
+      fields: "objectId,Name,Username,Status",
+      limit: -1,
+      order: "-createdAt",
+      where: { Subscription: subscriptionId, eye: { in: "1,0" } }
+    });
+    return r.results ?? [];
+  }
+  /** `POST /databases/create` — provision a database + user; the reconciler does the rest. */
+  async create(input) {
+    const r = await this.client.console("POST", "/databases/create", {
+      body: input,
+      tolerateHttpError: true
+    });
+    if (!r?.ok) throw new RoxyonApiError(r?.error || "Could not create the database.", { body: r });
+    return r;
+  }
+  /** `POST /databases/delete` */
+  async delete(databaseId) {
+    const r = await this.client.console("POST", "/databases/delete", {
+      body: { database: databaseId },
+      tolerateHttpError: true
+    });
+    if (!r?.ok) throw new RoxyonApiError(r?.error || "Could not delete the database.", { body: r });
+    return r;
+  }
+};
+
 // src/domains.ts
 var DomainsApi = class {
   constructor(client) {
@@ -605,6 +640,41 @@ var DomainsApi = class {
   }
 };
 
+// src/email.ts
+var EmailApi = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  async list(subscriptionId) {
+    const r = await this.client.get("/Emails", {
+      fields: "objectId,Email,LocalPart,Status,Quota",
+      limit: -1,
+      order: "-createdAt",
+      where: { Subscription: subscriptionId, eye: { in: "1,0" } }
+    });
+    return r.results ?? [];
+  }
+  /** `POST /emails/create` — provision a mailbox; the reconciler does the rest. */
+  async create(input) {
+    const r = await this.client.console("POST", "/emails/create", {
+      body: input,
+      tolerateHttpError: true
+    });
+    if (!r?.ok) throw new RoxyonApiError(r?.error || "Could not create the mailbox.", { body: r });
+    return r;
+  }
+  /** `POST /emails/delete` */
+  async delete(emailId) {
+    const r = await this.client.console("POST", "/emails/delete", {
+      body: { email: emailId },
+      tolerateHttpError: true
+    });
+    if (!r?.ok) throw new RoxyonApiError(r?.error || "Could not delete the mailbox.", { body: r });
+    return r;
+  }
+};
+
 // src/sites.ts
 var SitesApi = class {
   constructor(client) {
@@ -649,6 +719,30 @@ var SitesApi = class {
   }
 };
 
+// src/ssh.ts
+var SshApi = class {
+  constructor(client) {
+    this.client = client;
+  }
+  client;
+  /** `POST /ssh/password` */
+  async resetPassword(input = {}) {
+    const r = await this.client.console("POST", "/ssh/password", {
+      body: input,
+      tolerateHttpError: true
+    });
+    if (!r?.ok) {
+      throw new RoxyonApiError(
+        r?.error || "Could not reset the password.",
+        {
+          body: r
+        }
+      );
+    }
+    return r;
+  }
+};
+
 // src/subscriptions.ts
 var SubscriptionsApi = class {
   constructor(client) {
@@ -824,6 +918,9 @@ var Roxyon = class {
   domains;
   applications;
   sites;
+  databases;
+  email;
+  ssh;
   constructor(options = {}) {
     this.client = options instanceof RoxyonClient ? options : new RoxyonClient(options);
     this.auth = new AuthApi(this.client);
@@ -833,6 +930,9 @@ var Roxyon = class {
     this.domains = new DomainsApi(this.client);
     this.applications = new ApplicationsApi(this.client);
     this.sites = new SitesApi(this.client);
+    this.databases = new DatabasesApi(this.client);
+    this.email = new EmailApi(this.client);
+    this.ssh = new SshApi(this.client);
   }
   get sessionToken() {
     return this.client.getSessionToken();
@@ -845,13 +945,16 @@ export {
   DEFAULT_APP,
   DEFAULT_BAAS_URL,
   DEFAULT_CONSOLE_URL,
+  DatabasesApi,
   DomainsApi,
+  EmailApi,
   LUMEN_BUILD,
   RUNTIMES,
   Roxyon,
   RoxyonApiError,
   RoxyonClient,
   SitesApi,
+  SshApi,
   SubscriptionsApi,
   TokensApi,
   assertOk,