@protobase/schema 0.62.1 → 0.62.3

package/dist/app-address.d.ts

@@ -33,6 +33,8 @@ export declare const addressWords: {
   readonly tab: "tab";
   /** A record's standard page, `standard=true`, on a view whose record page is a component of the app's own. */
   readonly standard: "standard";
+  /** A record page that joins the record's call, `call=join`, as a ring's Accept and a call mark's Join open it. */
+  readonly call: "call";
 };
 /** The path of `address` below `basePath` (such as `/admin`), every name and key encoded the one way the app reads them. */
 export declare const appPath: (address: AppAddress, basePath?: string) => string;

package/dist/app-address.js

@@ -32,7 +32,9 @@ const addressWords = {
 	/** A record page's shown tab, by title. */
 	tab: "tab",
 	/** A record's standard page, `standard=true`, on a view whose record page is a component of the app's own. */
-	standard: "standard"
+	standard: "standard",
+	/** A record page that joins the record's call, `call=join`, as a ring's Accept and a call mark's Join open it. */
+	call: "call"
 };
 const listWords = [
 	"list",
@@ -90,6 +92,7 @@ const recordQuery = (address) => {
 	for (const title of address.open ?? []) query.append(addressWords.open, title);
 	if (address.tab) query.set(addressWords.tab, address.tab);
 	if (address.standard) query.set(addressWords.standard, "true");
+	if (address.call) query.set(addressWords.call, address.call);
 	const text = query.toString();
 	return text ? `?${text}` : "";
 };
@@ -143,6 +146,7 @@ const readAppPath = (pathAndQuery, pages) => {
 		const open = [...new Set(url.searchParams.getAll(addressWords.open).filter((title) => title !== ""))];
 		const tab = url.searchParams.get(addressWords.tab) || void 0;
 		const standard = url.searchParams.get(addressWords.standard) === "true";
+		const call = url.searchParams.get(addressWords.call) === "join";
 		return {
 			kind: "record",
 			resource: first,
@@ -150,7 +154,8 @@ const readAppPath = (pathAndQuery, pages) => {
 			...url.searchParams.get(addressWords.edit) === "true" && { edit: true },
 			...open.length > 0 && { open },
 			...tab && { tab },
-			...standard && { standard }
+			...standard && { standard },
+			...call && { call: "join" }
 		};
 	}
 	const params = url.searchParams;

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

@@ -0,0 +1,32 @@
+//#region src/calls/call-rings.d.ts
+/**
+ * A call that rings the signed-in user now, as the open pages of the app show it: the call, its record, who started
+ * it, the ring's text, and how many milliseconds it still rings, by the server's clock.
+ */
+export type CallRing = {
+  call: string;
+  resource: string;
+  /** The record's key as its URL has it. */
+  key: string;
+  started_by: string;
+  title: string;
+  body: string | null;
+  remaining_ms: number;
+};
+/**
+ * The resource name of the notices the live stream sends a user when the calls that ring them change, keyed by the
+ * user's id: no resource has a `$` in its name.
+ */
+export declare const ringNotice = "$rings";
+/** Decline, as a ring's path takes it. */
+export declare const declineWord = "decline";
+/**
+ * The path of the calls that ring the caller under the API's system path (`/api`), or of declining the ring of one
+ * call, `{ decline: call }`.
+ */
+export declare const ringsPath: (systemPath: string, part?: {
+  decline: string;
+}) => string;
+/** The event a record's channel hears its calls on, from the server, with `{ items }` as `GET /{resource}/{key}:calls` answers. */
+export declare const callsChannelEvent = "calls";
+//#endregion

package/dist/calls/call-rings.js

@@ -0,0 +1,21 @@
+//#region src/calls/call-rings.ts
+/**
+* The resource name of the notices the live stream sends a user when the calls that ring them change, keyed by the
+* user's id: no resource has a `$` in its name.
+*/
+const ringNotice = "$rings";
+/** Decline, as a ring's path takes it. */
+const declineWord = "decline";
+/**
+* The path of the calls that ring the caller under the API's system path (`/api`), or of declining the ring of one
+* call, `{ decline: call }`.
+*/
+const ringsPath = (systemPath, part) => {
+	const base = `${systemPath}/calls/rings`;
+	if (part === void 0) return base;
+	return `${base}/${encodeURIComponent(part.decline)}/${declineWord}`;
+};
+/** The event a record's channel hears its calls on, from the server, with `{ items }` as `GET /{resource}/{key}:calls` answers. */
+const callsChannelEvent = "calls";
+//#endregion
+export { callsChannelEvent, declineWord, ringNotice, ringsPath };

package/dist/internal.d.ts

@@ -38,4 +38,5 @@ import { Availability, PersonStatus, StatusInput, availabilities, heldStatus, ma
 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";
-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 };
+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 };

package/dist/internal.js

@@ -37,4 +37,5 @@ 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, 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 };
+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 };

package/dist/model.d.ts

@@ -282,6 +282,8 @@ export type AppAddress = {
    * component of the app's own (`.record({ component })`). A view without one ignores it.
    */
   standard?: boolean;
+  /** `join` when the page joins the record's call, as a ring's Accept and a call mark's Join open it. */
+  call?: 'join';
 } | {
   /** The form for a new record. */
   kind: 'create';

package/package.json

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