palbase 0.33.0 → 0.35.0

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

@@ -53,6 +53,10 @@ export type Call = {
      * Its people and bots
      */
     participants: Participant[];
+    /**
+     * The place it is held at, as the project names it (a channel of its app, a conversation: channel:42, conversation:<id>): the place's people — whom the project's rule lets in — find it going on and join it unasked. Null for a call of no place
+     */
+    place: string | null;
     /**
      * Whether it rings the people asked (false: a huddle they join)
      */
@@ -102,6 +106,10 @@ export type CallEvent = {
      * user or bot
      */
     participant_kind?: string;
+    /**
+     * The place it is held at (null for a call of no place)
+     */
+    place: string | null;
     /**
      * The call's room on the media server: what an agent's ticket is for
      */
@@ -240,6 +248,10 @@ export type HookSettings = {
      * A hook that does not answer: refuse the call, or let it
      */
     on_error?: "deny" | "allow";
+    /**
+     * The hook answers places too (action place: may this person see and join the calls held at a place). Off, it is never asked of a place, and a place's call is seen only by the people asked into it (a conversation:<id> place's members aside)
+     */
+    places?: boolean;
     /**
      * How long it is waited for (100 to 5,000; 2,000)
      */
@@ -262,6 +274,23 @@ export type InviteRequest = {
      */
     user_ids: string[];
 };
+/**
+ * Comes into a group call on a device
+ */
+export type JoinRequest = {
+    /**
+     * The device it is joined on
+     */
+    device_id: string;
+    /**
+     * Their picture, an https URL, likewise
+     */
+    image_url?: string | null;
+    /**
+     * What the others see of one who comes in unasked (a place's), where nothing else names them
+     */
+    name?: string | null;
+};
 /**
  * A device's way into the call's room on the media server, where every call's media flows — one to one or in a group: its url and the ticket its client connects with
  */
@@ -332,6 +361,20 @@ export type Participant = {
      */
     user_id: string;
 };
+/**
+ * A place and its call: going on, or — told to a watcher as it ends — its last, ended (with its version: a snapshot that comes late is known for older); no call when none goes on there. Participants carry no device_id
+ */
+export type PlaceView = {
+    call?: Call;
+    /**
+     * The place
+     */
+    place: string;
+    /**
+     * How long the reader is told of the place's call (the place event on their calls channel) before the watch is asked again — a watch's answer alone
+     */
+    watch_seconds?: number;
+};
 /**
  * A call to make
  */
@@ -362,12 +405,16 @@ export type StartCallRequest = {
     metadata?: {
         [key: string]: string;
     };
+    /**
+     * Holds the call at a place (a group call): letters, digits and . _ : -, 1 to 128 (channel:42; conversation:<id> for a conversation of Palbase's messaging, whose members it lets in). One call goes on at a place at a time. Who it lets in is the project's rule: a conversation's members, else the project's hook (calls.can_call, action place); with no hook, no one but those asked
+     */
+    place?: string | null;
     /**
      * Ring them (true, by default); false: a group call they join (a huddle)
      */
     ring?: boolean;
     /**
-     * Who to call: one person (a direct call), or several (a group)
+     * Who to call: one person (a direct call), or several (a group); none for a call at a place, which its people join
      */
     user_ids: string[];
     /**
@@ -375,6 +422,25 @@ export type StartCallRequest = {
      */
     video?: boolean;
 };
+/**
+ * A call not started: why, and — when a call goes on at its place (place_busy) — that call, to join
+ */
+export type StartRefused = {
+    call?: Call;
+    /**
+     * The refusal's name
+     */
+    error: string;
+    /**
+     * What it means
+     */
+    error_description: string;
+    /**
+     * The request's id
+     */
+    request_id?: string;
+    [key: string]: unknown;
+};
 /**
  * A way in for an agent
  */
@@ -517,6 +583,39 @@ export declare function client(t: Transport): {
         body: TicketRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<201, Ticket>>;
+    /**
+     * A place's call
+     *
+     * The call going on at the place, if one is, for a reader the place lets in: one of those in it or asked, or whom the project's rule lets in (a conversation's members for a conversation:<id> place, else the project's hook; with no hook, no one else).
+     */
+    getCallPlace(input: {
+        path: {
+            place: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, PlaceView>>;
+    /**
+     * Watch a place
+     *
+     * The reader is told of the place's call — started, changed, ended (no call) — as the place event on their calls channel, for watch_seconds; an app showing the place asks again before it runs out. Answered with the place's call as it is.
+     */
+    watchCallPlace(input: {
+        path: {
+            place: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<200, PlaceView>>;
+    /**
+     * Stop watching a place
+     *
+     * The reader is told no more of the place's call.
+     */
+    unwatchCallPlace(input: {
+        path: {
+            place: string;
+        }; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        signal?: AbortSignal;
+    }): Promise<Reply<204, undefined>>;
     /**
      * Call settings
      *
@@ -591,13 +690,13 @@ export declare function client(t: Transport): {
     /**
      * Join a group call
      *
-     * Comes into a group call the reader was asked to — rung, missed, declined, or in before — on the device.
+     * Comes into a group call the reader was asked to — rung, missed, declined, or in before — on the device; or, unasked, a call held at a place whose rule lets the reader in.
      */
     joinCall(input: {
         path: {
             call_id: string;
         };
-        body: DeviceRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
+        body: JoinRequest; /** Stops the call: the request in flight, a wait before a retry, a proof-of-work being solved. */
         signal?: AbortSignal;
     }): Promise<Reply<200, Call>>;
     /**

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

@@ -210,11 +210,11 @@ export type Machine = {
      */
     replicas: number;
     /**
-     * Kept awake: a machine of a size that sleeps is never put to sleep when idle, and is started again at once when it is asleep — while its environment has paid rights (Pay as you go with a balance), which pays its every hour. Without them it sleeps as any; a dedicated size never sleeps.
+     * Kept awake: a machine of a size that sleeps is never put to sleep when idle, and is started again at once when it is asleep — while its environment has paid rights (Pay as you go), which pays its every hour. Without them it sleeps as any; a dedicated size never sleeps.
      */
     always_on: boolean;
     /**
-     * Whether a pull request opened against its branch is previewed: its head built into a machine of its own, <name>-pr<n>, in this environment, with this environment's settings and secrets, answering at <name>-pr<n>-<ref> until the pull request closes; the pull request is told where in a comment. Turn it on in an environment kept for previews, not production's: the pull request's code runs with the environment's secrets.
+     * Whether a pull request opened against its branch is previewed: its head built into a machine of its own, <name>-pr<n>, in this environment, with this environment's settings and secrets, answering at <name>-pr<n>-<ref> until the pull request closes; the pull request is told where in a comment. Any environment previews, production's too: the pull request's code runs with the environment's settings, secrets and users, with a database of its own when the machine runs its database's migrations.
      */
     previews: boolean;
     /**
@@ -303,11 +303,11 @@ export type MachineCreate = {
      */
     replicas?: number;
     /**
-     * Keeps it awake (Machine.always_on): open to an environment on Pay as you go with a balance, refused `always_on_not_available` otherwise.
+     * Keeps it awake (Machine.always_on): open to an environment on Pay as you go, refused `always_on_not_available` otherwise.
      */
     always_on?: boolean;
     /**
-     * Whether a pull request opened against its branch is previewed: its head built into a machine of its own, <name>-pr<n>, in this environment, with this environment's settings and secrets, answering at <name>-pr<n>-<ref> until the pull request closes; the pull request is told where in a comment. Turn it on in an environment kept for previews, not production's: the pull request's code runs with the environment's secrets. A machine read with a platform's tokens (source.access token) previews what its platform puts (PUT /machines/{name}/previews/{pull_request}), no comment written.
+     * Whether a pull request opened against its branch is previewed: its head built into a machine of its own, <name>-pr<n>, in this environment, with this environment's settings and secrets, answering at <name>-pr<n>-<ref> until the pull request closes; the pull request is told where in a comment. Any environment previews, production's too: the pull request's code runs with the environment's settings, secrets and users, with a database of its own when the machine runs its database's migrations. A machine read with a platform's tokens (source.access token) previews what its platform puts (PUT /machines/{name}/previews/{pull_request}), no comment written.
      */
     previews?: boolean;
     /**
@@ -396,7 +396,7 @@ export type MachineUpdate = {
      */
     replicas?: number;
     /**
-     * Whether it is kept awake from now on (Machine.always_on): no version changes. Turning it on is open to an environment on Pay as you go with a balance, refused `always_on_not_available` otherwise.
+     * Whether it is kept awake from now on (Machine.always_on): no version changes. Turning it on is open to an environment on Pay as you go, refused `always_on_not_available` otherwise.
      */
     always_on?: boolean;
     /**
@@ -538,9 +538,13 @@ export type Database = {
      */
     awake_hours?: number;
     /**
-     * How long its size lets it run in a month, in hours: past it, it sleeps until the month ends, and a client is told so. Absent for a size with no such limit.
+     * How long a Free environment's free and preview databases may run in a month between them, in hours (environment_awake_hours): past it, they sleep until the month ends, and a client is told so. Absent for a size with no such limit.
      */
     awake_hours_limit?: number;
+    /**
+     * How long the environment's free and preview databases have run this month between them, deleted ones too, in hours: what awake_hours_limit holds — a database deleted and opened again gets no new hours. Present with awake_hours_limit.
+     */
+    environment_awake_hours?: number;
     /**
      * How much it held when last measured — every database in it summed, the ones its owner made too — measured while it is awake. Absent before its first measure.
      */
@@ -802,6 +806,14 @@ export type DatabaseLimits = {
      * The connections it takes (Postgres' max_connections).
      */
     connections: number;
+    /**
+     * The sessions its direct port (5432) takes at once.
+     */
+    direct_connections: number;
+    /**
+     * The transactions its pooled port (6543) runs at once.
+     */
+    pooled_connections: number;
 };
 /**
  * One bucket of a database's usage.
@@ -965,9 +977,13 @@ export type DatabaseCreated = {
      */
     awake_hours?: number;
     /**
-     * How long its size lets it run in a month, in hours: past it, it sleeps until the month ends, and a client is told so. Absent for a size with no such limit.
+     * How long a Free environment's free and preview databases may run in a month between them, in hours (environment_awake_hours): past it, they sleep until the month ends, and a client is told so. Absent for a size with no such limit.
      */
     awake_hours_limit?: number;
+    /**
+     * How long the environment's free and preview databases have run this month between them, deleted ones too, in hours: what awake_hours_limit holds — a database deleted and opened again gets no new hours. Present with awake_hours_limit.
+     */
+    environment_awake_hours?: number;
     /**
      * How much it held when last measured — every database in it summed, the ones its owner made too — measured while it is awake. Absent before its first measure.
      */
@@ -1197,6 +1213,14 @@ export type DatabaseSize = {
      * A week asleep, its volume is taken back and its next connection brings it back from its backup.
      */
     archives: boolean;
+    /**
+     * How many sessions its direct port (5432) takes at once: a session holds one until it ends, and a client past them is refused (53300).
+     */
+    direct_connections: number;
+    /**
+     * How many transactions its pooled port (6543) runs at once, however many of its clients are connected: a transaction that finds none of them free within 20 s is refused (53300).
+     */
+    pooled_connections: number;
     /**
      * A size counted against the project's free databases; the others are paid for.
      */
@@ -1476,7 +1500,7 @@ export type Site = {
     source: SiteSourceView;
     build: SiteBuildSettings;
     /**
-     * Whether a pull request opened against its source's branch is previewed: its head built, with this environment's build settings, into a release of its own that answers at <name>-pr<n>-<ref> until the pull request closes — never what the site serves, none of its releases; the pull request is told where in a comment. Turn it on in an environment kept for previews, not production's.
+     * Whether a pull request opened against its source's branch is previewed: its head built, with this environment's build settings, into a release of its own that answers at <name>-pr<n>-<ref> until the pull request closes — never what the site serves, none of its releases; the pull request is told where in a comment. Any environment previews, production's too: the pull request's build runs with the environment's settings.
      */
     previews: boolean;
     /**
@@ -1522,7 +1546,7 @@ export type SiteCreate = {
     source?: SiteSource;
     build?: SiteBuildSettings;
     /**
-     * Whether a pull request opened against its source's branch is previewed: its head built, with this environment's build settings, into a release of its own that answers at <name>-pr<n>-<ref> until the pull request closes — never what the site serves, none of its releases; the pull request is told where in a comment. Turn it on in an environment kept for previews, not production's.
+     * Whether a pull request opened against its source's branch is previewed: its head built, with this environment's build settings, into a release of its own that answers at <name>-pr<n>-<ref> until the pull request closes — never what the site serves, none of its releases; the pull request is told where in a comment. Any environment previews, production's too: the pull request's build runs with the environment's settings.
      */
     previews?: boolean;
     /**
@@ -1858,7 +1882,7 @@ export type PreviewOpened = {
     commit: string;
 };
 /**
- * A platform's pull request: its branch — one of the machine's repository's own — the head its machine's preview builds, and the token it is read with.
+ * A platform's pull request: its branch — one of the machine's repository's own — the head its machine's preview builds, and, for a machine read with a platform's tokens, the token it is read with.
  */
 export type PreviewDeploy = {
     /**
@@ -1870,9 +1894,9 @@ export type PreviewDeploy = {
      */
     commit?: string;
     /**
-     * A GitHub App installation's token (ghs_…) for the machine's repository alone, read-only: used once, never kept.
+     * For a machine read with a platform's tokens (source.access token), and required for one: a GitHub App installation's token (ghs_…) for the machine's repository alone, read-only, used once, never kept. A machine read with Palbase's GitHub App takes none (400 token_not_taken): its branch is read with the project's installation.
      */
-    git_access_token: string;
+    git_access_token?: string;
 };
 /** Palbase Machines */
 export declare function client(t: Transport): {
@@ -2044,7 +2068,7 @@ export declare function client(t: Transport): {
     /**
      * Open or update a platform's pull request preview
      *
-     * For a machine read with a platform's tokens (source.access token: PalCore's, whose repositories have no Palbase App, so no pull request is heard here): opens the preview of the pull request at the head of its branch — one of the machine's repository's own: a fork's is not built — its own machine, <name>-pr<n>, and a database of its own when the machine runs its database's migrations — or builds the open one at it, and opens one that went idle again. The branch is read with git_access_token, a GitHub App installation's token for the machine's repository alone (ghs_…), once; a commit named must be the branch's head (409 commit_not_head). Its address and state are read with GET /machines/{name}/previews; the platform tells its pull request itself. Refused in a production environment (409 previews_in_production), for a machine read with Palbase's GitHub App (409 previews_from_github), with previews off (409 previews_off), and when the environment's limits refuse the preview (409 preview_refused, with why).
+     * For a platform — PalCore — that previews its product's machine itself: one read with its tokens (source.access token), whose pull requests are not heard here, or one read with Palbase's GitHub App, whose numbers then are the platform's (a pull request GitHub told of keeps its own: 409 preview_taken). Opens the preview of the pull request at the head of its branch — one of the machine's repository's own: a fork's is not built — its own machine, <name>-pr<n>, and a database of its own when the machine runs its database's migrations — or builds the open one at it, and opens one that went idle again. A machine read with tokens has its branch read with git_access_token, a GitHub App installation's token for the machine's repository alone (ghs_…), once (400 token_required without); one read with Palbase's App, with the project's installation (400 token_not_taken with one). A commit named must be the branch's head (409 commit_not_head). Any environment previews, production's too: the preview runs with its settings, secrets and users. Its address and state are read with GET /machines/{name}/previews; the platform tells its pull request itself. Refused with previews off (409 previews_off), and when the environment's limits refuse the preview (409 preview_refused, with why).
      */
     putMachinePreview(input: {
         path: {
@@ -2057,7 +2081,7 @@ export declare function client(t: Transport): {
     /**
      * Close a platform's pull request preview
      *
-     * For a machine read with a platform's tokens: closes the preview of the pull request, its pull request closed — its machine and its own database are deleted at once. A machine read with Palbase's GitHub App has its previews closed as GitHub tells (409 previews_from_github).
+     * Closes a preview its platform put (PUT): its machine and its own database are deleted at once. A preview GitHub told of closes as its pull request does (409 previews_from_github).
      */
     deleteMachinePreview(input: {
         path: {