palbase 0.28.0 → 0.30.0

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

@@ -500,9 +500,9 @@ export type Database = {
      */
     pooled_port: number;
     /**
-     * The database's size. free: 0.25 vCPU, 512 MiB, 1 GB, put to sleep when idle (woken by the next connection in about 10 s), awake 400 hours a month at most, archived after a week asleep (its next connection brings it back from its backup); hobby: 0.25 vCPU, 512 MiB, 5 GB, put to sleep when idle, no monthly limit; shared-1g: 1 GiB, up to 1 vCPU, 10 GB; shared-2g: 2 GiB, up to 2 vCPU, 25 GB; shared-4g: 4 GiB, up to 2 vCPU, 50 GB; dedicated-1x: 1 vCPU of its own, 4 GiB, 25 GB; dedicated-2x: 2 vCPU of its own, 8 GiB, 50 GB. The shared and dedicated sizes never sleep and live on a Premium SSD v2 disk of their own; free and hobby on the platform's SAN. A database past its size's storage turns read-only. What a project's machines and databases reserve between them is held to its limit: a size that does not fit is refused (409 `machines_over_limit`).
+     * The database's size. free: 0.25 vCPU, 512 MiB, 1 GB, put to sleep when idle (woken by the next connection in about 10 s), awake 400 hours a month at most, archived after a week asleep (its next connection brings it back from its backup); hobby: 0.25 vCPU, 512 MiB, 5 GB, put to sleep when idle, no monthly limit; shared-1g: 1 GiB, up to 1 vCPU, 10 GB; shared-2g: 2 GiB, up to 2 vCPU, 25 GB; shared-4g: 4 GiB, up to 2 vCPU, 50 GB; dedicated-1x: 1 vCPU of its own, 4 GiB, 25 GB; dedicated-2x: 2 vCPU of its own, 8 GiB, 50 GB. The shared and dedicated sizes never sleep and live on a Premium SSD v2 disk of their own; free and hobby on the platform's SAN. A database past its size's storage turns read-only. What a project's machines and databases reserve between them is held to its limit: a size that does not fit is refused (409 `machines_over_limit`). preview: a machine's pull request preview's own database — 0.25 vCPU, 512 MiB, 500 MB, put to sleep when idle — opened with its preview and deleted with it; no database is opened at or moved to it.
      */
-    size: "dedicated-1x" | "dedicated-2x" | "free" | "hobby" | "shared-1g" | "shared-2g" | "shared-4g";
+    size: "dedicated-1x" | "dedicated-2x" | "free" | "hobby" | "preview" | "shared-1g" | "shared-2g" | "shared-4g";
     /**
      * Where its data lives, as its size says: san, the platform's SAN; premium, a Premium SSD v2 disk of its own.
      */
@@ -1714,9 +1714,13 @@ export type Preview = {
      */
     url: string;
     /**
-     * building, ready, failed — or closed: its pull request closed, and its address answers no more.
+     * authorization_required — a fork's head waiting for an admin of the environment to authorize it (fork protection): nothing of it is built until one does, and each push asks again —, building, ready, failed, refused — a machine's preview its environment's limits refused at its last push (reason says why): the next push, or previews:open, tries again —, idle — a machine's preview whose pull request had no push for 3 days: its machine and its own database are taken away, and the next push, or previews:open, makes them again — or closed: its pull request closed, its address answers no more.
+     */
+    state: "authorization_required" | "building" | "ready" | "failed" | "refused" | "idle" | "closed";
+    /**
+     * Why a machine's preview was refused (state refused).
      */
-    state: "building" | "ready" | "failed" | "closed";
+    reason?: string;
     /**
      * A machine's preview: its own machine, by name.
      */
@@ -1724,6 +1728,15 @@ export type Preview = {
     created_at: string;
     updated_at: string;
     closed_at?: string;
+    /**
+     * The fork's head an admin last authorized.
+     */
+    authorized_commit?: string;
+    /**
+     * Who authorized it: a developer's id, or the credential the call presented.
+     */
+    authorized_by?: string;
+    authorized_at?: string;
 };
 /**
  * A site's or a machine's previews, the fifty newest first.
@@ -1735,12 +1748,12 @@ export type PreviewList = {
  * One record of a domain's DNS.
  */
 export type DNSRecord = {
-    type: "CNAME" | "TXT";
+    type: "A" | "CNAME" | "TXT";
     name: string;
     value: string;
 };
 /**
- * A domain of the customer's own a site or a machine answers at too. Its owner adds its records to its DNS: the CNAME points it at the platform (at the apex, where DNS takes no CNAME: an ALIAS, ANAME or flattened CNAME to the same target), the TXT shows it is this environment's. It answers once Cloudflare has its certificate and the TXT record is there. A domain is one environment's, platform-wide, until it is deleted there.
+ * A domain of the customer's own a site or a machine answers at too. Its owner adds its records to its DNS: a subdomain's CNAME points it at the platform through Cloudflare; an apex's A record names the platform's address for apexes, which any DNS host takes (its certificate the edge's, from Let's Encrypt) — or, where its DNS host has one, an ALIAS, ANAME or flattened CNAME to the subdomains' target keeps it behind Cloudflare. The TXT shows it is this environment's. It answers once its certificate is issued and the TXT record is there. A domain may send its visitors to another domain of the same site or machine (redirect_to). A domain is one environment's, platform-wide, until it is deleted there.
  */
 export type Domain = {
     /**
@@ -1752,9 +1765,21 @@ export type Domain = {
      */
     state: "pending" | "active";
     /**
-     * A domain of its own, not a subdomain: most DNS hosts take no CNAME there.
+     * A domain of its own, not a subdomain: its DNS takes an A record at the platform's address for apexes (records), or an ALIAS, ANAME or flattened CNAME to the subdomains' target.
      */
     apex: boolean;
+    /**
+     * How it reaches the platform, as last read: cdn through Cloudflare (its certificate Cloudflare's), ip an apex's A record at the platform's address for apexes (its certificate Let's Encrypt's); null while its DNS says neither.
+     */
+    via: ("cdn" | "ip") | null;
+    /**
+     * Another domain of the same site or machine its visitors are sent to, the same path and query there (Vercel's "Redirect to"); null when it answers itself.
+     */
+    redirect_to: string | null;
+    /**
+     * The redirect's status: 308 unless said; null with redirect_to.
+     */
+    redirect_status: (301 | 302 | 307 | 308) | null;
     /**
      * What its owner adds to its DNS.
      */
@@ -1774,13 +1799,63 @@ export type DomainList = {
     domains: Domain[];
 };
 /**
- * A domain to add.
+ * A domain to add — sending its visitors to another of the same site's or machine's when redirect_to names one.
  */
 export type DomainCreate = {
     /**
      * The domain: www.example.com, or example.com — none of the platform's own.
      */
     host: string;
+    /**
+     * Another domain of the same site or machine, added before, its visitors are sent to (an apex to its www, or a www to its apex). It may not redirect itself, and this one may not be another's target.
+     */
+    redirect_to?: string;
+    /**
+     * The redirect's status, with redirect_to: 308 unless said.
+     */
+    redirect_status?: 301 | 302 | 307 | 308;
+};
+/**
+ * Where a domain sends its visitors: another domain of the same site or machine, or null to have it answer itself. It holds at once.
+ */
+export type DomainUpdate = {
+    /**
+     * Another domain of the same site or machine (one that redirects nowhere itself), or null.
+     */
+    redirect_to: string | null;
+    /**
+     * The redirect's status, with redirect_to: 308 unless said.
+     */
+    redirect_status?: 301 | 302 | 307 | 308;
+};
+/**
+ * The fork's head an admin authorizes: the one they looked at, which must be the pull request's newest.
+ */
+export type PreviewAuthorize = {
+    /**
+     * The pull request's head, as its preview says (Preview.commit).
+     */
+    commit: string;
+};
+/**
+ * An authorization taken: the preview is being built at the commit.
+ */
+export type PreviewAuthorized = {
+    pull_request: number;
+    commit: string;
+};
+/**
+ * A machine's preview opened again.
+ */
+export type PreviewOpened = {
+    /**
+     * The pull request's number.
+     */
+    pull_request: number;
+    /**
+     * The pull request's head it is built at.
+     */
+    commit: string;
 };
 /** Palbase Machines */
 export declare function client(t: Transport): {
@@ -1975,7 +2050,7 @@ export declare function client(t: Transport): {
     /**
      * Delete a machine's domain
      *
-     * Takes a domain away: it answers no more at once, and another environment may add it.
+     * Takes a domain away: it answers no more at once, and another environment may add it. One another domain redirects to is kept (409 domain_redirected_to): change that one's redirect first.
      */
     deleteMachineDomain(input: {
         path: {
@@ -1984,6 +2059,19 @@ 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<204, undefined>>;
+    /**
+     * Set where a machine's domain redirects
+     *
+     * Sends the domain's visitors to another domain of the same machine — the same path and query there, with redirect_status (308 unless said) — or, redirect_to null, has it answer itself. It holds at the edge at once. A domain redirects to one that redirects nowhere, and one others redirect to answers itself.
+     */
+    updateMachineDomain(input: {
+        path: {
+            name: string; /** The domain. */
+            host: string;
+        };
+        body: DomainUpdate; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Domain>>;
     /**
      * Read a build
      *
@@ -2570,7 +2658,7 @@ export declare function client(t: Transport): {
     /**
      * Delete a site's domain
      *
-     * Takes a domain away: it answers no more at once, and another environment may add it.
+     * Takes a domain away: it answers no more at once, and another environment may add it. One another domain redirects to is kept (409 domain_redirected_to): change that one's redirect first.
      */
     deleteSiteDomain(input: {
         path: {
@@ -2579,6 +2667,19 @@ 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<204, undefined>>;
+    /**
+     * Set where a site's domain redirects
+     *
+     * Sends the domain's visitors to another domain of the same site — the same path and query there, with redirect_status (308 unless said) — or, redirect_to null, has it answer itself. It holds at the edge at once. A domain redirects to one that redirects nowhere, and one others redirect to answers itself.
+     */
+    updateSiteDomain(input: {
+        path: {
+            name: string; /** The domain. */
+            host: string;
+        };
+        body: DomainUpdate; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, Domain>>;
     /**
      * Get a site's build
      *
@@ -2591,5 +2692,43 @@ 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<200, SiteBuild>>;
+    /**
+     * Authorize a fork's pull request's preview
+     *
+     * Builds the preview of a pull request from a fork at the head an admin looked at (fork protection, Vercel's Git Fork Protection: a fork's code runs with the environment's settings and secrets). The head must be the pull request's newest: a push since answers 409 preview_head_moved. Each new push asks again.
+     */
+    authorizeSitePreview(input: {
+        path: {
+            name: string; /** The pull request's number. */
+            pull_request: number;
+        };
+        body: PreviewAuthorize; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, PreviewAuthorized>>;
+    /**
+     * Authorize a fork's pull request's preview
+     *
+     * Builds the preview of a pull request from a fork at the head an admin looked at (fork protection, Vercel's Git Fork Protection: a fork's code runs with the environment's settings and secrets). The head must be the pull request's newest: a push since answers 409 preview_head_moved. Each new push asks again.
+     */
+    authorizeMachinePreview(input: {
+        path: {
+            name: string; /** The pull request's number. */
+            pull_request: number;
+        };
+        body: PreviewAuthorize; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, PreviewAuthorized>>;
+    /**
+     * Open a machine's pull request preview again
+     *
+     * Opens a machine's preview of an open pull request again, at the pull request's head: one closed for want of a push (state idle: no push for 3 days, its machine and its own database taken away) or refused at its last push (state refused) is made anew, with a new, empty database of its own when the machine runs its database's migrations. One open goes on as it is, and its 3 days start again. A fork's preview under fork protection opens only at a head an admin authorized (409 preview_waits_authorization); one the environment's limits refuse again answers 409 preview_refused, with why.
+     */
+    openMachinePreview(input: {
+        path: {
+            name: string; /** The pull request's number. */
+            pull_request: number;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<202, PreviewOpened>>;
 };
 export type Client = ReturnType<typeof client>;

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

@@ -868,9 +868,9 @@ export type Message = {
      */
     attachments: Attachment[];
     /**
-     * What a call message keeps of its call (kind call): written as the call starts, and again as it is answered and as it ends. It counts as no unread message.
+     * What a call message keeps of its call (kind call): written as the call starts, and again as it is answered and as it ends. It counts as no unread message. Always sent (null on any other message); absent (an answer kept from before it was): null.
      */
-    call: CallRecord | null;
+    call?: CallRecord | null;
     /**
      * The writer's app's own id of it.
      */