@protobase/schema 0.59.2 → 0.60.0

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

@@ -8,7 +8,10 @@ export type CallVideoLayer = {
   height: number;
   bitrate: number;
 };
-/** A track the browser is about to send: `cid` is its `MediaStreamTrack.id`, which its offer names in `msid`. */
+/**
+ * A track the browser is about to send: `cid` is the id its description names it by in `msid`, its `MediaStreamTrack.id`
+ * to a media server, the id of the stream it is sent on to other members (`peer`).
+ */
 export type CallTrackRequest = {
   cid: string;
   kind: 'audio' | 'video';
@@ -26,6 +29,8 @@ export type CallCandidate = {
 };
 /** What the browser hands a new server session so it resumes the member's media session where the last one left it. */
 export type CallResume = {
+  /** The call the member is in, from `joined`: a resume of a call that ended is refused. */
+  call: string;
   /** The member's participant in the media server, from `joined`. */
   participant: string;
   /** The browser's current local (offer) and remote (answer) descriptions, with a media server. */
@@ -94,11 +99,20 @@ export type CallRemoteTrack = {
   source: CallTrackSource;
   muted: boolean;
 };
-/** Why the member is no longer in the call: `ended` and `removed` are final, `rejoin` asks the browser to join anew. */
-export type CallLeftReason = 'ended' | 'removed' | 'refused' | 'rejoin';
+/**
+ * Why the member is no longer in the call: `ended`, `removed`, `full` and `refused` are final, `rejoin` asks the
+ * 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). */
+export type CallRosterMember = {
+  member: string;
+  joined_at: string;
+};
 /** A message from the server. */
 export type CallServerMessage = {
   type: 'joined';
+  call: string;
   mode: CallMode;
   participant: string;
   iceServers: {
@@ -142,6 +156,11 @@ export type CallServerMessage = {
   type: 'unpublished';
   sid: string;
 } |
+/** Everyone in the call, the member too, in the order they came, whenever that changes. */
+{
+  type: 'members';
+  members: CallRosterMember[];
+} |
 /** With `peer`: every other member in the call, whenever that changes. */
 {
   type: 'peers';

package/dist/internal.d.ts

@@ -34,7 +34,8 @@ import { capacitorOrigin } from "./capacitor-origins.js";
 import { pushRecord, serviceWorkerFile } from "./push-record.js";
 import { deviceIdParam, devicesPath } from "./devices-path.js";
 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, CallServerMessage, CallTrackRequest, CallTrackSource, CallVideoLayer } from "./calls/call-protocol.js";
-export { type AddressCheck, type CallCandidate, type CallClientMessage, type CallDescription, type CallLeftReason, type CallMode, type CallRemoteTrack, type CallResume, type CallServerMessage, type CallTrackRequest, type CallTrackSource, type CallVideoLayer, type FormulaNode, type Locale, type MobileReleaseAnswer, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type ReleaseBinding, type SearchTerm, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, builtInFieldTypes, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+import { CallCandidate, CallClientMessage, CallDescription, CallLeftReason, CallMode, CallRemoteTrack, CallResume, CallRosterMember, CallServerMessage, CallTrackRequest, CallTrackSource, CallVideoLayer } from "./calls/call-protocol.js";
+export { type AddressCheck, type Availability, type CallCandidate, type CallClientMessage, type CallDescription, type CallLeftReason, type CallMode, type CallRemoteTrack, type CallResume, 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, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, 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, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/internal.js

@@ -34,6 +34,7 @@ import { capacitorOrigin } from "./capacitor-origins.js";
 import { pushRecord, serviceWorkerFile } from "./push-record.js";
 import { deviceIdParam, devicesPath } from "./devices-path.js";
 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";
-export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, builtInFieldTypes, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, datesErrors, 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, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/status.d.ts

@@ -0,0 +1,26 @@
+//#region src/status.d.ts
+/** Whether a person may be reached: `automatic` says nothing, `busy` is a mark only, `do_not_disturb` holds their pushes. */
+export declare const availabilities: readonly ["automatic", "busy", "do_not_disturb"];
+export type Availability = (typeof availabilities)[number];
+/** The most characters a custom status holds, counted as a person sees them, an emoji as one. */
+export declare const maxStatusText = 100;
+/** A person's status as the API answers it: `text` and `clearsAt` are `null` when not set. */
+export type PersonStatus = {
+  userId: string;
+  availability: Availability;
+  text: string | null;
+  clearsAt: string | null;
+};
+/** What a person sets: an availability, a custom text, and when it clears, an ISO time, `null` for never. */
+export type StatusInput = {
+  availability: Availability;
+  text: string | null;
+  clearsAt: string | null;
+};
+/** The path of the status endpoints under the API's system path (`/api`): the caller's own, or `people` they share an organization with. */
+export declare const statusPath: (systemPath: string, part?: "people") => string;
+/** What is wrong with a custom status text, as a sentence to show; `undefined` when it may be set. */
+export declare const statusTextProblem: (text: string) => "A status is one line of text, without control characters" | "A status is at most 100 characters" | undefined;
+/** The status as it holds at `now`: none once its clear time has passed, or when it says nothing. */
+export declare const heldStatus: <S extends Pick<PersonStatus, "availability" | "text" | "clearsAt">>(status: S | null | undefined, now?: number) => S | undefined;
+//#endregion

package/dist/status.js

@@ -0,0 +1,26 @@
+//#region src/status.ts
+/** Whether a person may be reached: `automatic` says nothing, `busy` is a mark only, `do_not_disturb` holds their pushes. */
+const availabilities = [
+	"automatic",
+	"busy",
+	"do_not_disturb"
+];
+/** The most characters a custom status holds, counted as a person sees them, an emoji as one. */
+const maxStatusText = 100;
+/** The path of the status endpoints under the API's system path (`/api`): the caller's own, or `people` they share an organization with. */
+const statusPath = (systemPath, part) => `${systemPath}/status${part === void 0 ? "" : `/${part}`}`;
+const controlCharacter = /\p{Cc}/u;
+/** What is wrong with a custom status text, as a sentence to show; `undefined` when it may be set. */
+const statusTextProblem = (text) => {
+	if (controlCharacter.test(text)) return "A status is one line of text, without control characters";
+	if ([...text].length > 100) return `A status is at most 100 characters`;
+};
+/** The status as it holds at `now`: none once its clear time has passed, or when it says nothing. */
+const heldStatus = (status, now = Date.now()) => {
+	if (!status) return;
+	if (status.clearsAt !== null && Date.parse(status.clearsAt) <= now) return;
+	if (status.availability === "automatic" && status.text === null) return;
+	return status;
+};
+//#endregion
+export { availabilities, heldStatus, maxStatusText, statusPath, statusTextProblem };

package/package.json

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