@protobase/schema 0.16.0 → 0.16.1

package/dist/app-address.d.ts

@@ -15,6 +15,8 @@ export declare const addressWords: {
   readonly filterLayout: "layout";
   /** Where a list's map display looks: `latitude,longitude,zoom`. */
   readonly map: "map";
+  /** The saved search a list was opened from, by its key. */
+  readonly savedSearch: "saved_search";
   /** The second path segment that opens a resource's create form instead of a record. */
   readonly create: "new";
 };

package/dist/app-address.js

@@ -15,6 +15,8 @@ const addressWords = {
 	filterLayout: "layout",
 	/** Where a list's map display looks: `latitude,longitude,zoom`. */
 	map: "map",
+	/** The saved search a list was opened from, by its key. */
+	savedSearch: "saved_search",
 	/** The second path segment that opens a resource's create form instead of a record. */
 	create: "new"
 };
@@ -22,7 +24,8 @@ const listWords = [
 	"display",
 	"filter",
 	"orderBy",
-	"filterLayout"
+	"filterLayout",
+	"savedSearch"
 ];
 const mapText = (view) => `${view.latitude.toFixed(5)},${view.longitude.toFixed(5)},${view.zoom.toFixed(2)}`;
 const inRange = (value, limit, low = -limit) => Number.isFinite(value) && value >= low && value <= limit;
@@ -101,6 +104,7 @@ const readAppPath = (pathAndQuery, pages) => {
 	const orderBy = params.get(addressWords.orderBy) || void 0;
 	const layout = filterLayout(params.get(addressWords.filterLayout));
 	const map = readMap(params.get(addressWords.map));
+	const savedSearch = params.get(addressWords.savedSearch) || void 0;
 	return {
 		kind: "list",
 		resource: first,
@@ -108,7 +112,8 @@ const readAppPath = (pathAndQuery, pages) => {
 		...filter && { filter },
 		...orderBy && { orderBy },
 		...layout && { filterLayout: layout },
-		...map && { map }
+		...map && { map },
+		...savedSearch && { savedSearch }
 	};
 };
 //#endregion

package/dist/model.d.ts

@@ -176,6 +176,11 @@ export type AppAddress = {
   filterLayout?: FilterLayout;
   /** Where its map display looks. */
   map?: MapView;
+  /**
+   * The saved search the list was opened from, by its key in the text form the record API takes: while the list's
+   * filter differs from the search's, the list offers to update the search.
+   */
+  savedSearch?: string;
 } | {
   /** One record. */
   kind: 'record';
@@ -402,13 +407,14 @@ export type SearchesOfModel = {
   resource: string;
   /** The text field holding the search's filter, as the list's address has it. */
   filter: string;
-  /** The text field a new search is named in, from its filters; the view's title shows it. */
+  /** The text field holding the name the user gives a search, if any; without one, the search's filters are its title. */
   name?: string;
   /** Enum and boolean fields changed in place on each search, such as how often to hear of new records. */
   controls?: string[];
   /**
-   * With it, each search shows only the records new to the user: those whose `field` (of `resource`) is after the
-   * search's `seenAt` (a timestamp field of this resource), which opening all of its results sets to now.
+   * With it, each search shows its records newest first by `field` (of `resource`) and marks those new to the user:
+   * those whose `field` is after the search's `seenAt` (a timestamp field of this resource), which opening all of its
+   * results sets to now.
    */
   unseen?: {
     /** When the user last opened the search's results. */
@@ -416,7 +422,7 @@ export type SearchesOfModel = {
     /** The searched resource's timestamp that makes a record new, such as when it was published. */
     field: string;
   };
-  /** How many records each search shows; default 12. */
+  /** How many records each search shows at most; default every one it finds, loaded as its row scrolls. */
   limit?: number;
 };
 /** A view's list page (`.list(...)`). */

package/dist/view.d.ts

@@ -122,8 +122,8 @@ export declare class ViewBuilder<R extends {
   saveSearch(search: SaveSearchModel): ViewBuilder<R>;
   /**
    * This resource holds saved searches of `resource`, which a list page saves with `.saveSearch(...)`: its list page
-   * shows each of the user's searches with its filters, its `controls` to change in place, the newest records it finds
-   * (with `unseen`, only those new since the user last opened its results) and a link to all of them. Throws in
+   * shows each of the user's searches with its filters, its `controls` to change in place, the records it finds (with
+   * `unseen`, newest first, those new since the user last opened its results marked) and a link to all of them. Throws in
    * `toModel` when `filter` or `name` is not a text field, `unseen.seenAt` not a timestamp or a control not an enum or
    * boolean field.
    * See [Saved searches](website/src/content/docs/reference/ui-config.mdx#saved-searches).

package/dist/view.js

@@ -153,8 +153,8 @@ var ViewBuilder = class ViewBuilder {
 	}
 	/**
 	* This resource holds saved searches of `resource`, which a list page saves with `.saveSearch(...)`: its list page
-	* shows each of the user's searches with its filters, its `controls` to change in place, the newest records it finds
-	* (with `unseen`, only those new since the user last opened its results) and a link to all of them. Throws in
+	* shows each of the user's searches with its filters, its `controls` to change in place, the records it finds (with
+	* `unseen`, newest first, those new since the user last opened its results marked) and a link to all of them. Throws in
 	* `toModel` when `filter` or `name` is not a text field, `unseen.seenAt` not a timestamp or a control not an enum or
 	* boolean field.
 	* See [Saved searches](website/src/content/docs/reference/ui-config.mdx#saved-searches).

package/package.json

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