@protobase/schema 0.22.3 → 0.22.5

package/dist/app-address.d.ts

@@ -5,7 +5,7 @@ import { AppAddress } from "./model.js";
  * changes in this module alone.
  */
 export declare const addressWords: {
-  /** A list's filter (AIP-160), as the list API takes it. */
+  /** A list's filter (AIP-160), as the list API takes it. An empty `filter=` means no filter, in place of the view's default. */
   readonly filter: "filter";
   /** A list's order (AIP-132). */
   readonly orderBy: "order_by";

package/dist/app-address.js

@@ -5,7 +5,7 @@ import { encodeKey } from "./keys.js";
 * changes in this module alone.
 */
 const addressWords = {
-	/** A list's filter (AIP-160), as the list API takes it. */
+	/** A list's filter (AIP-160), as the list API takes it. An empty `filter=` means no filter, in place of the view's default. */
 	filter: "filter",
 	/** A list's order (AIP-132). */
 	orderBy: "order_by",
@@ -66,7 +66,8 @@ const listQuery = (address) => {
 	const query = new URLSearchParams();
 	for (const name of listWords) {
 		const value = address[name];
-		if (value !== void 0 && value !== "") query.set(addressWords[name], value);
+		if (value === void 0 || value === "" && name !== "filter") continue;
+		query.set(addressWords[name], value);
 	}
 	if (address.map) query.set(addressWords.map, mapText(address.map));
 	if (address.calendar) query.set(addressWords.calendar, calendarText(address.calendar));
@@ -136,7 +137,7 @@ const readAppPath = (pathAndQuery, pages) => {
 	}
 	const params = url.searchParams;
 	const display = params.get(addressWords.display) || void 0;
-	const filter = params.get(addressWords.filter) || void 0;
+	const filter = params.get(addressWords.filter) ?? void 0;
 	const orderBy = params.get(addressWords.orderBy) || void 0;
 	const layout = filterLayout(params.get(addressWords.filterLayout));
 	const map = readMap(params.get(addressWords.map));
@@ -146,7 +147,7 @@ const readAppPath = (pathAndQuery, pages) => {
 		kind: "list",
 		resource: first,
 		...display && { display },
-		...filter && { filter },
+		...filter !== void 0 && { filter },
 		...orderBy && { orderBy },
 		...layout && { filterLayout: layout },
 		...map && { map },

package/dist/model.d.ts

@@ -523,6 +523,8 @@ export type ListModel = {
   columns: string[];
   /** The order the list starts in. */
   sort?: SortSpec;
+  /** An AIP-160 filter the list opens with when its address names none; the person can clear or change it, and a link's own filter replaces it. */
+  filter?: string;
   /** Defaults for the UI's search box. `ResourceModel.search` is authoritative for what `search(...)` matches on the server. */
   search?: string[];
   /** Other ways to show the list besides its table, in the order the switch shows them after it. */
@@ -566,7 +568,7 @@ export type DatePreset = 'today' | 'yesterday' | '24h' | '7d' | '30d' | '90d' |
  * A filter widget above a list (`.filters((r, w) => ...)`), on a filterable field; see
  * [Filters and the chart](website/src/content/docs/reference/ui-config.mdx#filters-and-the-chart).
  */
-export type FilterWidgetModel = {
+export type FilterWidgetModel = ({
   /** A slider between the lowest and highest value. */
   kind: 'range';
   /** The field it filters. */
@@ -599,6 +601,9 @@ export type FilterWidgetModel = {
   fields: string[];
   /** The menu's label. */
   label: string;
+}) & {
+  /** Shown behind the bar's "More filters" menu until it is picked there or set. */
+  secondary?: boolean;
 };
 /**
  * Records of another resource on the record page: those whose `field` holds this record's key or, with `through`,

package/dist/view-widgets.d.ts

@@ -1,10 +1,12 @@
 import { DatePreset, FilterWidgetModel } from "./model.js";
 import { Ref } from "./refs.js";
 //#region src/view-widgets.d.ts
+/** Every widget also takes `secondary: true`, which puts it behind the bar's "More filters" menu until it is picked there or set. */
 export declare const widgets: {
   /** A slider between the field's lowest and highest value; `histogram` draws the values' histogram behind it. */
   range: (ref: Ref, o?: {
     histogram?: boolean;
+    secondary?: boolean;
   }) => FilterWidgetModel;
   /**
    * A menu of the field's values with counts; `search` adds a search box for long lists. On a relation it searches the
@@ -12,19 +14,24 @@ export declare const widgets: {
    */
   facets: (ref: Ref, o?: {
     search?: boolean;
+    secondary?: boolean;
   }) => FilterWidgetModel;
   /** A date range with buttons for the `presets`, such as `today` and `30d`. */
   dateRange: (ref: Ref, o?: {
     presets?: DatePreset[];
+    secondary?: boolean;
   }) => FilterWidgetModel;
   /** A switch for a boolean field. */
-  toggle: (ref: Ref) => FilterWidgetModel;
+  toggle: (ref: Ref, o?: {
+    secondary?: boolean;
+  }) => FilterWidgetModel;
   /**
    * A menu of boolean fields under one `label`, such as "for sale" and "for rent": a record shows when any chosen field
    * is true, so one that is both shows under each.
    */
   flags: (refs: Ref<string, boolean | null>[], o: {
     label: string;
+    secondary?: boolean;
   }) => FilterWidgetModel;
 };
 //#endregion

package/dist/view-widgets.js

@@ -1,10 +1,12 @@
 //#region src/view-widgets.ts
+/** Every widget also takes `secondary: true`, which puts it behind the bar's "More filters" menu until it is picked there or set. */
 const widgets = {
 	/** A slider between the field's lowest and highest value; `histogram` draws the values' histogram behind it. */
 	range: (ref, o = {}) => ({
 		kind: "range",
 		field: ref.name,
-		histogram: o.histogram ?? false
+		histogram: o.histogram ?? false,
+		...o.secondary && { secondary: true }
 	}),
 	/**
 	* A menu of the field's values with counts; `search` adds a search box for long lists. On a relation it searches the
@@ -13,18 +15,21 @@ const widgets = {
 	facets: (ref, o = {}) => ({
 		kind: "facets",
 		field: ref.name,
-		search: o.search ?? false
+		search: o.search ?? false,
+		...o.secondary && { secondary: true }
 	}),
 	/** A date range with buttons for the `presets`, such as `today` and `30d`. */
 	dateRange: (ref, o = {}) => ({
 		kind: "dateRange",
 		field: ref.name,
-		presets: o.presets ?? []
+		presets: o.presets ?? [],
+		...o.secondary && { secondary: true }
 	}),
 	/** A switch for a boolean field. */
-	toggle: (ref) => ({
+	toggle: (ref, o = {}) => ({
 		kind: "toggle",
-		field: ref.name
+		field: ref.name,
+		...o.secondary && { secondary: true }
 	}),
 	/**
 	* A menu of boolean fields under one `label`, such as "for sale" and "for rent": a record shows when any chosen field
@@ -33,7 +38,8 @@ const widgets = {
 	flags: (refs, o) => ({
 		kind: "flags",
 		fields: refs.map((ref) => ref.name),
-		label: o.label
+		label: o.label,
+		...o.secondary && { secondary: true }
 	})
 };
 //#endregion

package/dist/view.d.ts

@@ -68,7 +68,7 @@ export declare class ViewBuilder<R extends {
   /** Hints per field, such as `{ total: r.total.prefix('€').decimals(2) }`; calls add up. */
   fields(build: (r: FieldViews<R>) => Record<string, FieldView>): ViewBuilder<R>;
   /**
-   * The list: its table's `columns`, fields or columns of related records (`c.related`), `sort` and `search`, the
+   * The list: its table's `columns`, fields or columns of related records (`c.related`), `sort`, `search` and a `filter` it opens with, the
    * columns that are `editable` in their cell, and other `displays` to switch to (`d.cards`, `d.map`, `d.board`, `d.calendar`, `d.custom`), one of which
    * may be the `default` the list opens in. Throws when display or column names collide, `default` names none or an
    * editable field is not among the columns. See
@@ -78,6 +78,7 @@ export declare class ViewBuilder<R extends {
     columns: Array<Ref | ListColumn>;
     sort?: Array<[Ref, 'asc' | 'desc']>;
     search?: Ref[];
+    filter?: string;
     editable?: Ref[];
     displays?: ListDisplayModel[];
     default?: string;

package/dist/view.js

@@ -75,14 +75,14 @@ var ViewBuilder = class ViewBuilder {
 		} });
 	}
 	/**
-	* The list: its table's `columns`, fields or columns of related records (`c.related`), `sort` and `search`, the
+	* The list: its table's `columns`, fields or columns of related records (`c.related`), `sort`, `search` and a `filter` it opens with, the
 	* columns that are `editable` in their cell, and other `displays` to switch to (`d.cards`, `d.map`, `d.board`, `d.calendar`, `d.custom`), one of which
 	* may be the `default` the list opens in. Throws when display or column names collide, `default` names none or an
 	* editable field is not among the columns. See
 	* [Editing in the list](website/src/content/docs/reference/ui-config.mdx#editing-in-the-list).
 	*/
 	list(build) {
-		const { columns: columns$1, sort, search, editable, displays: shown = [], default: opens } = build(this.refs(), displays, columns);
+		const { columns: columns$1, sort, search, filter, editable, displays: shown = [], default: opens } = build(this.refs(), displays, columns);
 		const related = columns$1.filter(isListColumn).map(({ kind: _, ...column }) => column);
 		const names = columns$1.map((column) => column.name);
 		const repeated = names.find((name, index) => names.indexOf(name) !== index);
@@ -94,6 +94,7 @@ var ViewBuilder = class ViewBuilder {
 			...related.length > 0 && { relatedColumns: related },
 			...sort && { sort: sort.map(([ref, dir]) => [ref.name, dir]) },
 			...search && { search: search.map((ref) => ref.name) },
+			...filter !== void 0 && filter !== "" && { filter },
 			...editable && editable.length > 0 && { editable: editable.map((ref) => ref.name) },
 			...shown.length > 0 && { displays: shown },
 			...opens !== void 0 && { default: opens }

package/package.json

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