@protobase/schema 0.62.4 → 0.63.0

package/dist/calls/call-guests.d.ts

@@ -0,0 +1,7 @@
+//#region src/calls/call-guests.d.ts
+/**
+ * The path of the guests' routes under the API's system path (`/api`), or of one of them: the lobby, the guest call
+ * socket, and an organization's switch for guest links.
+ */
+export declare const guestCallsPath: (systemPath: string, part?: "lobby" | "socket" | "organization") => string;
+//#endregion

package/dist/calls/call-guests.js

@@ -0,0 +1,8 @@
+//#region src/calls/call-guests.ts
+/**
+* The path of the guests' routes under the API's system path (`/api`), or of one of them: the lobby, the guest call
+* socket, and an organization's switch for guest links.
+*/
+const guestCallsPath = (systemPath, part) => `${systemPath}/calls/guests${part ? `/${part}` : ""}`;
+//#endregion
+export { guestCallsPath };

package/dist/calls/call-protocol.d.ts

@@ -51,11 +51,13 @@ export type CallDescription = {
 };
 /** How the call's media flows: through a media server, or directly between the members' browsers. */
 export type CallMode = 'sfu' | 'peer';
-/** A message from the browser. */
+/** A message from the browser. `guest` is a guest's token, on the guest call socket only. */
 export type CallClientMessage = {
   type: 'join';
+  guest?: string;
 } | ({
   type: 'resume';
+  guest?: string;
 } & CallResume) | {
   type: 'publish';
   tracks: CallTrackRequest[];
@@ -90,6 +92,24 @@ export type CallClientMessage = {
   hidden?: boolean;
 } | {
   type: 'leave';
+} |
+/** A member who may invite: a new guest link to the call, with the sources a guest may send and when it expires. */
+{
+  type: 'guest-link';
+  publish: CallTrackSource[];
+  expires_at?: string;
+} | {
+  type: 'guest-link-revoke';
+  link: string;
+} |
+/** Lets a waiting guest into the call, or turns them away. */
+{
+  type: 'guest-decide';
+  guest: string;
+  admit: boolean;
+} | {
+  type: 'guest-remove';
+  guest: string;
 };
 /** A track of another member the member hears. */
 export type CallRemoteTrack = {
@@ -104,11 +124,32 @@ export type CallRemoteTrack = {
  * browser to join anew, and `unavailable` is a server that could not take the member in, after the browser tried again.
  */
 export type CallLeftReason = 'ended' | 'removed' | 'full' | 'refused' | 'unavailable' | 'rejoin';
-/** Someone in a call, since when (ISO 8601). */
+/** Someone in a call, since when (ISO 8601), with the name they show: a guest's own, or the one the app gave the member. */
 export type CallRosterMember = {
   member: string;
   joined_at: string;
+  name?: string;
+};
+/** A guest waiting in the lobby of a call, by the name they gave, since when (ISO 8601). */
+export type CallLobbyGuest = {
+  guest: string;
+  name: string;
+  since: string;
 };
+/** A guest link of a call: who made it, what a guest may send, and until when (ISO 8601) it lets guests in. */
+export type CallGuestLink = {
+  id: string;
+  created_by: string;
+  publish: CallTrackSource[];
+  expires_at: string | null;
+};
+/**
+ * Why a member's guest request did nothing: the guest or link is gone, the call is full, the organization turned guest
+ * links off, the record has no organization to ask, or the member may not invite.
+ */
+export type CallGuestRefusal = 'gone' | 'full' | 'off' | 'no-organization' | 'not-allowed';
+/** A guest's lobby wait: waiting, let in, turned away, or the call or link is over. */
+export type CallGuestState = 'waiting' | 'admitted' | 'denied' | 'ended';
 /** A message from the server. */
 export type CallServerMessage = {
   type: 'joined';
@@ -181,5 +222,24 @@ export type CallServerMessage = {
 } | {
   type: 'left';
   reason: CallLeftReason;
+} |
+/** To a member who may invite: who waits in the lobby, and the call's guest links, whenever that changes. */
+{
+  type: 'lobby';
+  guests: CallLobbyGuest[];
+  links: CallGuestLink[];
+} |
+/** Each guest request is answered once, in order: the link a `guest-link` made, with its token, which only its maker gets, once. */
+{
+  type: 'guest-link';
+  link: CallGuestLink;
+  token: string;
+} |
+/** A `guest-link-revoke`, `guest-decide` or `guest-remove` that was done. */
+{
+  type: 'guest-done';
+} | {
+  type: 'guest-refused';
+  reason: CallGuestRefusal;
 };
 //#endregion

package/dist/internal.d.ts

@@ -37,6 +37,7 @@ import { historyIdParam, historyIdPattern, historyPath } from "./history-path.js
 import { Availability, PersonStatus, StatusInput, availabilities, heldStatus, maxStatusText, statusPath, statusTextProblem } from "./status.js";
 import { listColumnNames } from "./list-columns.js";
 import { builtInFieldTypes } from "./built-in-field-types.js";
-import { CallCandidate, CallClientMessage, CallDescription, CallLeftReason, CallMode, CallRemoteTrack, CallResume, CallRosterMember, CallServerMessage, CallTrackRequest, CallTrackSource, CallVideoLayer } from "./calls/call-protocol.js";
+import { CallCandidate, CallClientMessage, CallDescription, CallGuestLink, CallGuestRefusal, CallGuestState, CallLeftReason, CallLobbyGuest, CallMode, CallRemoteTrack, CallResume, CallRosterMember, CallServerMessage, CallTrackRequest, CallTrackSource, CallVideoLayer } from "./calls/call-protocol.js";
+import { guestCallsPath } from "./calls/call-guests.js";
 import { CallRing, callsChannelEvent, declineWord, ringNotice, ringsPath } from "./calls/call-rings.js";
-export { type AddressCheck, type Availability, type CallCandidate, type CallClientMessage, type CallDescription, type CallLeftReason, type CallMode, type CallRemoteTrack, type CallResume, type CallRing, type CallRosterMember, type CallServerMessage, type CallTrackRequest, type CallTrackSource, type CallVideoLayer, type FormulaNode, type Locale, type MobileReleaseAnswer, type PersonStatus, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type ReleaseBinding, type SearchTerm, type StatusInput, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { type AddressCheck, type Availability, type CallCandidate, type CallClientMessage, type CallDescription, type CallGuestLink, type CallGuestRefusal, type CallGuestState, type CallLeftReason, type CallLobbyGuest, type CallMode, type CallRemoteTrack, type CallResume, type CallRing, type CallRosterMember, type CallServerMessage, type CallTrackRequest, type CallTrackSource, type CallVideoLayer, type FormulaNode, type Locale, type MobileReleaseAnswer, type PersonStatus, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type ReleaseBinding, type SearchTerm, type StatusInput, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, guestCallsPath, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/internal.js

@@ -37,5 +37,6 @@ import { historyIdParam, historyIdPattern, historyPath } from "./history-path.js
 import { availabilities, heldStatus, maxStatusText, statusPath, statusTextProblem } from "./status.js";
 import { listColumnNames } from "./list-columns.js";
 import { builtInFieldTypes } from "./built-in-field-types.js";
+import { guestCallsPath } from "./calls/call-guests.js";
 import { callsChannelEvent, declineWord, ringNotice, ringsPath } from "./calls/call-rings.js";
-export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, guestCallsPath, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.62.4",
+  "version": "0.63.0",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {