@protobase/schema 0.54.6 → 0.55.0

package/dist/built-in-field-types.d.ts

@@ -0,0 +1,9 @@
+//#region src/built-in-field-types.d.ts
+/**
+ * The field types Protobase brings, which a view chooses with `.widget(name)` like a plugin's, by the storage types
+ * each shows: `members`, a JSON array of the user ids of an organization's members. A plugin's of the same name wins.
+ */
+export declare const builtInFieldTypes: {
+  readonly members: readonly ["json"];
+};
+//#endregion

package/dist/built-in-field-types.js

@@ -0,0 +1,8 @@
+//#region src/built-in-field-types.ts
+/**
+* The field types Protobase brings, which a view chooses with `.widget(name)` like a plugin's, by the storage types
+* each shows: `members`, a JSON array of the user ids of an organization's members. A plugin's of the same name wins.
+*/
+const builtInFieldTypes = { members: ["json"] };
+//#endregion
+export { builtInFieldTypes };

package/dist/internal.d.ts

@@ -35,4 +35,5 @@ import { pushRecord, serviceWorkerFile } from "./push-record.js";
 import { deviceIdParam, devicesPath } from "./devices-path.js";
 import { historyIdParam, historyIdPattern, historyPath } from "./history-path.js";
 import { listColumnNames } from "./list-columns.js";
-export { type AddressCheck, type FormulaNode, type Locale, type MobileReleaseAnswer, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, 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, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+import { builtInFieldTypes } from "./built-in-field-types.js";
+export { type AddressCheck, type FormulaNode, type Locale, type MobileReleaseAnswer, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, 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, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/internal.js

@@ -35,4 +35,5 @@ import { pushRecord, serviceWorkerFile } from "./push-record.js";
 import { deviceIdParam, devicesPath } from "./devices-path.js";
 import { historyIdParam, historyIdPattern, historyPath } from "./history-path.js";
 import { listColumnNames } from "./list-columns.js";
-export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, boardErrors, bottomBarFor, 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, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };
+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, renderPrompt, searchTerms, serviceWorkerFile, shapes, shownInputs, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources };

package/dist/model.d.ts

@@ -327,8 +327,9 @@ export type FieldViewModel = {
   /** `arrow` draws the field's badges as arrows pointing right, as on a rating scale such as the EU energy label. */
   badgeShape?: BadgeShape;
   /**
-   * The field type a plugin registers (`definePlugin({ fields })`) that shows and edits this field, with its props;
-   * without that plugin, or for a storage type it does not show, the field shows as it would without it.
+   * The field type a plugin registers (`definePlugin({ fields })`), or a built-in one such as `members`, that shows and
+   * edits this field, with its props; without it, or for a storage type it does not show, the field shows as it would
+   * without it.
    */
   widget?: FieldWidgetModel;
 };
@@ -611,7 +612,7 @@ export type ParentAccess = 'read' | 'update';
 /**
  * A record that a resource's records belong to through a relation field, such as an operation's VM: creating, changing,
  * deleting or undeleting a record needs `access` on the record `field` points at, checked with the caller's own access
- * rules on that resource. See
+ * rules on that resource; with `read`, every read of its records keeps to those whose parent the caller reads. See
  * [Records that belong to another](website/src/content/docs/reference/access.mdx#records-that-belong-to-another).
  */
 export type ParentModel = {

package/dist/resource.d.ts

@@ -114,8 +114,9 @@ export declare class ResourceBuilder<F extends FieldsInput = {}, K = never> {
   /**
    * A relation whose record each record belongs to, and the access on it writing them needs: creating a record, changing
    * it (the parent it leaves and the one it moves to), deleting and undeleting it all need `access` on the parent,
-   * checked with the caller's own access rules on its resource and locked until the write commits. A null relation
-   * checks nothing; each call adds a check. See
+   * checked with the caller's own access rules on its resource and locked until the write commits. With `read`, every
+   * read of its records (lists, counts, aggregates, gets and labels) also keeps to those whose parent the caller reads
+   * there. A null relation checks nothing; each call adds a check. See
    * [Records that belong to another](website/src/content/docs/reference/access.mdx#records-that-belong-to-another).
    *
    * @example

package/dist/resource.js

@@ -121,8 +121,9 @@ var ResourceBuilder = class ResourceBuilder {
 	/**
 	* A relation whose record each record belongs to, and the access on it writing them needs: creating a record, changing
 	* it (the parent it leaves and the one it moves to), deleting and undeleting it all need `access` on the parent,
-	* checked with the caller's own access rules on its resource and locked until the write commits. A null relation
-	* checks nothing; each call adds a check. See
+	* checked with the caller's own access rules on its resource and locked until the write commits. With `read`, every
+	* read of its records (lists, counts, aggregates, gets and labels) also keeps to those whose parent the caller reads
+	* there. A null relation checks nothing; each call adds a check. See
 	* [Records that belong to another](website/src/content/docs/reference/access.mdx#records-that-belong-to-another).
 	*
 	* @example

package/dist/view-field.d.ts

@@ -67,7 +67,9 @@ export declare class FieldView<N extends string = string, V = unknown> {
   icon(icon: string): FieldView<N, V>;
   /**
    * Shows and edits the field with the field type a plugin registers under `name` (`definePlugin({ fields })`), given
-   * `props`, such as `r.score.widget('rating', { max: 5 })`. Without that plugin, or when the field type does not show
+   * `props`, such as `r.score.widget('rating', { max: 5 })`, or with the built-in `members`, which picks an
+   * organization's members into a JSON array of user ids (see
+   * [Members](website/src/content/docs/reference/plugins.md#members)). Without that field type, or when it does not show
    * this field's storage type, the field shows as it would without it.
    */
   widget(name: string, props?: Record<string, JsonValue>): FieldView<N, V>;

package/dist/view-field.js

@@ -103,7 +103,9 @@ var FieldView = class FieldView {
 	}
 	/**
 	* Shows and edits the field with the field type a plugin registers under `name` (`definePlugin({ fields })`), given
-	* `props`, such as `r.score.widget('rating', { max: 5 })`. Without that plugin, or when the field type does not show
+	* `props`, such as `r.score.widget('rating', { max: 5 })`, or with the built-in `members`, which picks an
+	* organization's members into a JSON array of user ids (see
+	* [Members](website/src/content/docs/reference/plugins.md#members)). Without that field type, or when it does not show
 	* this field's storage type, the field shows as it would without it.
 	*/
 	widget(name, props) {

package/package.json

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