@roxyon/api-client 0.1.1 → 0.3.0

package/dist/index.d.cts

@@ -117,14 +117,13 @@ interface AccountSubscription {
     id: string;
     name: string;
     status: string;
-    node: string;
-    datacenter: string;
-    container: string;
 }
 interface AccountDomain {
     id: string;
     name: string;
     subscription: string;
+    /** `active`, or `provisioning` while a freshly-added host comes up. */
+    status?: string;
 }
 interface AccountContext {
     user: {
@@ -144,7 +143,6 @@ interface AccountApp {
     configRevision: number;
     appliedRevision: number;
     lastError: string | null;
-    sourcePath: string;
     repo: {
         url: string;
         branch: string;
@@ -152,9 +150,10 @@ interface AccountApp {
 }
 /**
  * `GET /account/context` — one call the CLI / MCP server use to plan a deploy:
- * the signed-in user, their subscriptions (with node), and their domains.
- * Resolvable by a session token OR a Personal Access Token, so a CI job with
- * only a PAT never has to touch the BaaS.
+ * the signed-in user, their subscriptions, and their domains. Resolvable by a
+ * session token OR a Personal Access Token, so a CI job with only a PAT never
+ * has to touch the BaaS. Infra details (nodes, datacenters, container names,
+ * filesystem paths) are deliberately not surfaced here.
  */
 declare class AccountApi {
     private readonly client;
@@ -365,15 +364,130 @@ 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;
 }
-/** Domains (hosts) attached to a subscription — used to place an application. */
+interface CreateDomainInput {
+    /** FQDN to host — a subdomain of a domain the account already hosts, or `*.roxyon.com`. */
+    host: string;
+    /** Subscription to attach it to. Omit when the account has exactly one. */
+    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;
+    objectId: string;
+    host: string;
+    /** `subdomain` of an owned parent, or `primary`. */
+    type: 'subdomain' | 'primary';
+    /** `provisioning` while DNS/vhost/TLS come up, then `active` (or `failed`). */
+    status: 'provisioning' | 'active' | 'failed';
+    error?: string;
+}
+/** Domains (hosts) attached to a subscription. */
 declare class DomainsApi {
     private readonly client;
     constructor(client: RoxyonClient);
     list(subscriptionId: string): Promise<Domain[]>;
+    /**
+     * `POST /domains/create` — provision a subdomain (DNS + vhost + auto-TLS). The
+     * server decides subdomain vs primary from the caller's existing hosts and
+     * writes the `pending` row; the platform's reconciler does the rest.
+     */
+    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 {
@@ -381,30 +495,72 @@ interface StaticDeployResult {
     host: string;
     path: string;
     files?: number;
+    bytes?: number;
     error?: string;
 }
+interface DeployOptions {
+    /** Replace the docroot contents instead of overlaying (keeps `.well-known`). */
+    clean?: boolean;
+    /** Flip the host to SPA routing: unmatched paths serve `/index.html`. */
+    spa?: boolean;
+}
+interface SiteFile {
+    /** POSIX path relative to the site root. */
+    path: string;
+    size: number;
+    type: 'file' | 'dir';
+}
+interface SiteFileContent {
+    path: string;
+    size: number;
+    encoding: 'utf8' | 'base64';
+    content: string;
+}
 /**
- * Static-site deploy: upload built files (a LumenJS `--serverless` build, or any
- * static output) into a host's document root
- * (`/home/www/<host>/public_html[/<folder>]`), served directly by nginx. No
- * Application row, no process.
- *
- * `POST /sites/deploy` — NEW endpoint (see `backend/` in this repo).
+ * Static-site hosting: the files under a host's document root
+ * (`public_html[/<folder>]`), served directly by nginx. No Application row, no
+ * process. All routes go to the console (`POST /sites/deploy`, `GET /sites/files`,
+ * `GET /sites/file`) and authenticate with a session token or a `roxp_` PAT.
  */
 declare class SitesApi {
     private readonly client;
     constructor(client: RoxyonClient);
-    deploy(host: string, folder: string, tarball: Uint8Array): Promise<StaticDeployResult>;
+    /** Upload a gzip tarball into `host`'s docroot (+ optional sub-`folder`). */
+    deploy(host: string, folder: string, tarball: Uint8Array, opts?: DeployOptions): Promise<StaticDeployResult>;
+    /** List the files currently in `host`'s docroot (optionally under `path`). */
+    listFiles(host: string, folder?: string, path?: string): Promise<SiteFile[]>;
+    /** Read one file from `host`'s docroot. */
+    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;
     Status?: string;
-    Username?: string;
-    /** Infra node the subscription's container lives on (internal). */
-    Node?: string;
-    Datacenter?: string;
     [k: string]: unknown;
 }
 interface Privilege {
@@ -536,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 CreateOnDeploy, type CreatedToken, DEFAULT_APP, DEFAULT_BAAS_URL, DEFAULT_CONSOLE_URL, type DeployKind, 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, 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

@@ -117,14 +117,13 @@ interface AccountSubscription {
     id: string;
     name: string;
     status: string;
-    node: string;
-    datacenter: string;
-    container: string;
 }
 interface AccountDomain {
     id: string;
     name: string;
     subscription: string;
+    /** `active`, or `provisioning` while a freshly-added host comes up. */
+    status?: string;
 }
 interface AccountContext {
     user: {
@@ -144,7 +143,6 @@ interface AccountApp {
     configRevision: number;
     appliedRevision: number;
     lastError: string | null;
-    sourcePath: string;
     repo: {
         url: string;
         branch: string;
@@ -152,9 +150,10 @@ interface AccountApp {
 }
 /**
  * `GET /account/context` — one call the CLI / MCP server use to plan a deploy:
- * the signed-in user, their subscriptions (with node), and their domains.
- * Resolvable by a session token OR a Personal Access Token, so a CI job with
- * only a PAT never has to touch the BaaS.
+ * the signed-in user, their subscriptions, and their domains. Resolvable by a
+ * session token OR a Personal Access Token, so a CI job with only a PAT never
+ * has to touch the BaaS. Infra details (nodes, datacenters, container names,
+ * filesystem paths) are deliberately not surfaced here.
  */
 declare class AccountApi {
     private readonly client;
@@ -365,15 +364,130 @@ 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;
 }
-/** Domains (hosts) attached to a subscription — used to place an application. */
+interface CreateDomainInput {
+    /** FQDN to host — a subdomain of a domain the account already hosts, or `*.roxyon.com`. */
+    host: string;
+    /** Subscription to attach it to. Omit when the account has exactly one. */
+    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;
+    objectId: string;
+    host: string;
+    /** `subdomain` of an owned parent, or `primary`. */
+    type: 'subdomain' | 'primary';
+    /** `provisioning` while DNS/vhost/TLS come up, then `active` (or `failed`). */
+    status: 'provisioning' | 'active' | 'failed';
+    error?: string;
+}
+/** Domains (hosts) attached to a subscription. */
 declare class DomainsApi {
     private readonly client;
     constructor(client: RoxyonClient);
     list(subscriptionId: string): Promise<Domain[]>;
+    /**
+     * `POST /domains/create` — provision a subdomain (DNS + vhost + auto-TLS). The
+     * server decides subdomain vs primary from the caller's existing hosts and
+     * writes the `pending` row; the platform's reconciler does the rest.
+     */
+    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 {
@@ -381,30 +495,72 @@ interface StaticDeployResult {
     host: string;
     path: string;
     files?: number;
+    bytes?: number;
     error?: string;
 }
+interface DeployOptions {
+    /** Replace the docroot contents instead of overlaying (keeps `.well-known`). */
+    clean?: boolean;
+    /** Flip the host to SPA routing: unmatched paths serve `/index.html`. */
+    spa?: boolean;
+}
+interface SiteFile {
+    /** POSIX path relative to the site root. */
+    path: string;
+    size: number;
+    type: 'file' | 'dir';
+}
+interface SiteFileContent {
+    path: string;
+    size: number;
+    encoding: 'utf8' | 'base64';
+    content: string;
+}
 /**
- * Static-site deploy: upload built files (a LumenJS `--serverless` build, or any
- * static output) into a host's document root
- * (`/home/www/<host>/public_html[/<folder>]`), served directly by nginx. No
- * Application row, no process.
- *
- * `POST /sites/deploy` — NEW endpoint (see `backend/` in this repo).
+ * Static-site hosting: the files under a host's document root
+ * (`public_html[/<folder>]`), served directly by nginx. No Application row, no
+ * process. All routes go to the console (`POST /sites/deploy`, `GET /sites/files`,
+ * `GET /sites/file`) and authenticate with a session token or a `roxp_` PAT.
  */
 declare class SitesApi {
     private readonly client;
     constructor(client: RoxyonClient);
-    deploy(host: string, folder: string, tarball: Uint8Array): Promise<StaticDeployResult>;
+    /** Upload a gzip tarball into `host`'s docroot (+ optional sub-`folder`). */
+    deploy(host: string, folder: string, tarball: Uint8Array, opts?: DeployOptions): Promise<StaticDeployResult>;
+    /** List the files currently in `host`'s docroot (optionally under `path`). */
+    listFiles(host: string, folder?: string, path?: string): Promise<SiteFile[]>;
+    /** Read one file from `host`'s docroot. */
+    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;
     Status?: string;
-    Username?: string;
-    /** Infra node the subscription's container lives on (internal). */
-    Node?: string;
-    Datacenter?: string;
     [k: string]: unknown;
 }
 interface Privilege {
@@ -536,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 CreateOnDeploy, type CreatedToken, DEFAULT_APP, DEFAULT_BAAS_URL, DEFAULT_CONSOLE_URL, type DeployKind, 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, 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 };