palbase 0.34.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,7 +210,7 @@ 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;
     /**
@@ -303,7 +303,7 @@ 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;
     /**
@@ -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.
      */
@@ -973,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.
      */