@protobase/config 0.58.4 → 0.58.6

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import { AdminOptions, AppIdentity, AssistantOptions, AuthSettings, AuthenticateSettings, EventsOptions, FileProviderSettings, FilesOptions, HistoryOptions, JobDeclaration, MobileConfig, NotificationsOptions, RealtimeOptions, WebhooksOptions } from "@protobase/server";
+import { AdminOptions, AppIdentity, AssistantOptions, AuthSettings, AuthenticateSettings, CallsOptions, EventsOptions, FileProviderSettings, FilesOptions, HistoryOptions, JobDeclaration, MobileConfig, NotificationsOptions, RealtimeOptions, WebhooksOptions } from "@protobase/server";
 //#region src/config.d.ts
 /**
  * `auth`: sign-in (see `AuthSettings`). Its URL, secrets and name are the app's (`url`, `secret`, `previousSecrets`,
@@ -90,6 +90,8 @@ export type ProtobaseConfig = AppKeys & ApiOptionKeys & {
   realtime?: RealtimeOptions;
   /** Each user's devices and inbox (see `NotificationsOptions`); `{}` turns them on. */
   notifications?: Omit<NotificationsOptions, 'store' | 'historyStore' | 'senders'>;
+  /** The media server behind the calls functions admit members to with `calls.join` (see `CallsOptions`). */
+  calls?: CallsOptions;
   /** The app's iOS and Android build (see `MobileConfig`). */
   mobile?: MobileConfig;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/config",
-  "version": "0.58.4",
+  "version": "0.58.6",
   "description": "defineConfig and the types of a Protobase project's protobase.config.ts, and the JSON Schema of protobase.config.json.",
   "license": "Apache-2.0",
   "repository": {
@@ -31,6 +31,6 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@protobase/server": "0.58.4"
+    "@protobase/server": "0.58.6"
   }
 }

package/schema.json

@@ -979,6 +979,17 @@
         }
       ]
     },
+    "calls": {
+      "description": "The media server behind the calls functions admit members to with `calls.join` (see `CallsOptions`).",
+      "anyOf": [
+        {
+          "$ref": "#/definitions/CallsOptions"
+        },
+        {
+          "$ref": "#/definitions/EnvValue"
+        }
+      ]
+    },
     "mobile": {
       "description": "The app's iOS and Android build (see `MobileConfig`).",
       "anyOf": [
@@ -3457,6 +3468,170 @@
       },
       "additionalProperties": false
     },
+    "CallsOptions": {
+      "type": "object",
+      "properties": {
+        "backend": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/LiveKitBackend"
+            },
+            {
+              "$ref": "#/definitions/PeerBackend"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        }
+      },
+      "required": [
+        "backend"
+      ],
+      "additionalProperties": false
+    },
+    "LiveKitBackend": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "anyOf": [
+            {
+              "const": "livekit"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        },
+        "url": {
+          "description": "Its address, such as `wss://livekit.example.com` or `ws://127.0.0.1:7880`.",
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        },
+        "apiKey": {
+          "description": "The API key and secret Protobase signs each member's LiveKit token with.",
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        },
+        "apiSecret": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        }
+      },
+      "required": [
+        "kind",
+        "url",
+        "apiKey",
+        "apiSecret"
+      ],
+      "additionalProperties": false
+    },
+    "PeerBackend": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "anyOf": [
+            {
+              "const": "peer"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        },
+        "iceServers": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "$ref": "#/definitions/CallIceServer"
+                  },
+                  {
+                    "$ref": "#/definitions/EnvValue"
+                  }
+                ]
+              }
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        }
+      },
+      "required": [
+        "kind"
+      ],
+      "additionalProperties": false
+    },
+    "CallIceServer": {
+      "type": "object",
+      "properties": {
+        "urls": {
+          "anyOf": [
+            {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "$ref": "#/definitions/EnvValue"
+                  }
+                ]
+              }
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        },
+        "username": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        },
+        "credential": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "$ref": "#/definitions/EnvValue"
+            }
+          ]
+        }
+      },
+      "required": [
+        "urls"
+      ],
+      "additionalProperties": false
+    },
     "MobileConfig": {
       "type": "object",
       "properties": {