palbase 0.36.3 → 0.37.1

package/types/internal/src/modules/machines.d.ts

@@ -266,6 +266,8 @@ export type Machine = {
      * Why the contract of the build the machine serves from was refused, in its app's words where it said.
      */
     contract_error?: string;
+    environment?: EnvironmentRef;
+    moving_to?: EnvironmentRef;
 };
 /**
  * A machine to open.
@@ -347,6 +349,10 @@ export type MachineCreate = {
      * For a source read with tokens, the first build's commit (its full SHA): the branch's head (409 commit_not_head otherwise); the head when left out.
      */
     commit?: string;
+    /**
+     * The ref of the project's environment the machine is bound to (environment_not_found for one the caller does not reach: an environment's own token or key makes what is bound to its environment alone). None: the environment called. Its name is the project's one: name_taken when another environment holds a machine of that name.
+     */
+    environment?: string;
 };
 /**
  * A page of a project's machines, by name.
@@ -569,6 +575,7 @@ export type Database = {
      * How much its size lets it read from and write to its disk in a month: past it, it sleeps until the month ends, and a client is told so. Absent for a size with no such limit.
      */
     traffic_limit_bytes?: number;
+    environment?: EnvironmentRef;
 };
 /**
  * A page of a project's databases, by name.
@@ -600,6 +607,10 @@ export type DatabaseCreate = {
      * How many days the database's backups are kept: it can be brought back to any moment of them. 1 to 35.
      */
     backup_days?: number;
+    /**
+     * The ref of the project's environment the database is bound to (environment_not_found for one the caller does not reach: an environment's own token or key makes what is bound to its environment alone). None: the environment called. Its name is the project's one: name_taken when another environment holds a database of that name.
+     */
+    environment?: string;
 };
 /**
  * A change to a database; a field left out stays as it is.
@@ -852,6 +863,7 @@ export type MachineDatabase = {
      * The machine's releases run their migrations against the database before they serve (a Palbase backend's); they are run as the database's owner. A database's migrations are one machine's: a second machine asking for them is refused (409 `database_migrated_elsewhere`).
      */
     migrations?: boolean;
+    environment?: EnvironmentRef;
 };
 /**
  * When to bring the database back to.
@@ -1507,6 +1519,7 @@ export type Site = {
      * Whether a pull request from a fork — another repository, which anyone may open — is previewed too. Off by default: its build would run with the environment's build settings.
      */
     preview_forks: boolean;
+    environment?: EnvironmentRef;
 };
 /**
  * The release a site serves; none before its first.
@@ -1553,6 +1566,10 @@ export type SiteCreate = {
      * Whether a fork's pull requests are previewed (Site.preview_forks).
      */
     preview_forks?: boolean;
+    /**
+     * The ref of the project's environment the site is bound to (environment_not_found for one the caller does not reach: an environment's own token or key makes what is bound to its environment alone). None: the environment called. Its name is the project's one: name_taken when another environment holds a site of that name.
+     */
+    environment?: string;
 };
 /**
  * What to change of a site; a field left out is unchanged.
@@ -1898,17 +1915,42 @@ export type PreviewDeploy = {
      */
     git_access_token?: string;
 };
+/**
+ * An environment of the project, as a machine, a database or a site is bound to it: its ref — the one its address names — and its name. On a machine, a database or a site: the environment it is bound to — a machine takes that environment's settings, secrets and modules, a site is built with its settings and secrets, any machine of the project may be given a database whichever environment keeps it. On a machine's database: the environment that keeps it, when it is not the machine's; given in a change ({"ref": …}), the environment to find the database in — none finds it in the machine's own environment first, then in the project's others (ambiguous_database when two keep one of that name).
+ */
+export type EnvironmentRef = {
+    /**
+     * The environment's ref: where it answers (<ref>.<domain>), and what a machine's, a database's or a site's address ends with.
+     */
+    ref: string;
+    /**
+     * The environment's name.
+     */
+    name?: string;
+};
+/**
+ * Binds a machine to another environment of its project.
+ */
+export type MachineMove = {
+    /**
+     * The ref of the environment of the project the machine moves to.
+     */
+    environment: string;
+};
 /** Palbase Machines */
 export declare function client(t: Transport): {
     /**
      * List machines
      *
      * Lists the project's machines, by name.
+     *
+     * A project's machines, databases and sites are the project's, each bound to one of its environments: from any of its environments' addresses, one who reaches the project (a developer, an organization's token, an account token) lists every environment's, each naming its environment (environment). A name, in any request that names one (/machines/{name}/…), is found in the environment it is bound to and the request is answered there.
      */
     listMachines(input?: {
         query?: {
             limit?: number; /** The next_cursor of the previous page. Opaque; omit it for the first page. */
-            cursor?: string;
+            cursor?: string; /** The ref of one of the project's environments: what is bound to it alone. None: every environment the caller reaches — every one of the project's for a developer, an organization's token or an account token; an environment's own token or key reaches its environment alone. */
+            environment?: string;
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, MachinePage>>;
@@ -2178,11 +2220,14 @@ export declare function client(t: Transport): {
      * List the databases
      *
      * Lists the project's databases by name, deleted ones that may still be taken back among them.
+     *
+     * A project's machines, databases and sites are the project's, each bound to one of its environments: from any of its environments' addresses, one who reaches the project (a developer, an organization's token, an account token) lists every environment's, each naming its environment (environment). A name, in any request that names one (/databases/{name}/…), is found in the environment it is bound to and the request is answered there.
      */
     listDatabases(input?: {
         query?: {
             limit?: number; /** The next_cursor of the previous page. Opaque; omit it for the first page. */
-            cursor?: string;
+            cursor?: string; /** The ref of one of the project's environments: what is bound to it alone. None: every environment the caller reaches — every one of the project's for a developer, an organization's token or an account token; an environment's own token or key reaches its environment alone. */
+            environment?: string;
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, DatabasePage>>;
@@ -2556,8 +2601,13 @@ export declare function client(t: Transport): {
      * List sites
      *
      * Lists the project's sites, by name: a project has 10 at most.
+     *
+     * A project's machines, databases and sites are the project's, each bound to one of its environments: from any of its environments' addresses, one who reaches the project (a developer, an organization's token, an account token) lists every environment's, each naming its environment (environment). A name, in any request that names one (/sites/{name}/…), is found in the environment it is bound to and the request is answered there.
      */
     listSites(input?: {
+        query?: {
+            environment?: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, SiteList>>;
     /**
@@ -2796,5 +2846,17 @@ export declare function client(t: Transport): {
         }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<202, PreviewOpened>>;
+    /**
+     * Move a machine to another environment of its project
+     *
+     * Binds the machine to another environment of its project (the user's call of 2026-11-01): it takes that environment's settings, secrets and modules from its next start, and its address names it (<name>-<the environment's ref>). The operator moves it — out of the environment it leaves, into the new one at the version it serves — in its own pass: the machine says where it is moving (moving_to) until it has, a second or so. Its pull requests' previews are closed; a new push opens them in the new environment. The database it is given stays where it is kept, given across environments. Its name is the project's one (name_taken when the new environment holds a machine of that name); a machine with domains of its own does not move (machine_has_domains): they are removed first. It needs the admin role in both environments (environment_role_required); an environment's own token or key moves nothing out of it (environment_not_found).
+     */
+    moveMachine(input: {
+        path: {
+            name: string;
+        };
+        body: MachineMove; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, Machine>>;
 };
 export type Client = ReturnType<typeof client>;