@protobase/schema 0.12.8 → 0.12.10

package/dist/address-errors.d.ts

@@ -10,7 +10,8 @@ export type AddressCheck = {
 };
 /**
  * What is wrong with a link's address against these models: an unknown resource or page, a `{field}` the record it sits
- * on does not have, or a filter or order naming fields the resource does not have. Empty when it can be followed.
+ * on does not have, a filter or order naming fields the resource does not have, or create values for fields it does not
+ * have. Empty when it can be followed.
  */
 export declare const addressErrors: (to: AppAddress, { models, pages, source }: AddressCheck) => string[];
 //#endregion

package/dist/address-errors.js

@@ -31,7 +31,8 @@ const orderErrors = (model, orderBy) => {
 };
 /**
 * What is wrong with a link's address against these models: an unknown resource or page, a `{field}` the record it sits
-* on does not have, or a filter or order naming fields the resource does not have. Empty when it can be followed.
+* on does not have, a filter or order naming fields the resource does not have, or create values for fields it does not
+* have. Empty when it can be followed.
 */
 const addressErrors = (to, { models, pages, source }) => {
 	const placeholders = addressPlaceholders(to).flatMap((name) => {
@@ -45,6 +46,7 @@ const addressErrors = (to, { models, pages, source }) => {
 		case "create": {
 			const target = Object.hasOwn(models, to.resource) ? models[to.resource] : void 0;
 			if (!target) return [`unknown resource "${to.resource}"`];
+			if (to.kind === "create") return [...placeholders, ...Object.keys(to.values ?? {}).filter((name) => !Object.hasOwn(target.fields, name)).map((name) => `values: unknown field "${name}" on ${to.resource}`)];
 			if (to.kind !== "list") return placeholders;
 			return [
 				...placeholders,

package/dist/address-template.d.ts

@@ -4,7 +4,7 @@ import { AppAddress } from "./model.js";
 export declare const addressPlaceholders: (to: AppAddress) => string[];
 /** The fields an href takes from the record, from its `{field}` placeholders. */
 export declare const hrefPlaceholders: (href: string) => string[];
-/** `to` with every `{field}` in its key, filter and order replaced by the record's value; a missing value becomes empty. */
+/** `to` with every `{field}` in its key, filter, order or values replaced by the record's value; a missing value becomes empty. */
 export declare const fillAddress: (to: AppAddress, record?: Record<string, unknown>) => AppAddress;
 /**
  * Whether an href leaves the app: it starts with a scheme (`https:`, `mailto:`) or `//`. A path inside the app is an

package/dist/address-template.js

@@ -4,6 +4,7 @@ const names = (text) => [...text.matchAll(placeholder)].map((match) => match[1])
 const templated = (to) => {
 	if (to.kind === "record") return (Array.isArray(to.key) ? to.key : [to.key]).filter((part) => typeof part === "string");
 	if (to.kind === "list") return [to.filter, to.orderBy].filter((part) => part !== void 0);
+	if (to.kind === "create") return Object.values(to.values ?? {});
 	return [];
 };
 /** The fields whose values a link's address takes from the record, from its `{field}` placeholders. */
@@ -11,7 +12,7 @@ const addressPlaceholders = (to) => [...new Set(templated(to).flatMap(names))];
 /** The fields an href takes from the record, from its `{field}` placeholders. */
 const hrefPlaceholders = (href) => [...new Set(names(href))];
 const fill = (text, record) => text.replace(placeholder, (_, name) => record[name] === null || record[name] === void 0 ? "" : String(record[name]));
-/** `to` with every `{field}` in its key, filter and order replaced by the record's value; a missing value becomes empty. */
+/** `to` with every `{field}` in its key, filter, order or values replaced by the record's value; a missing value becomes empty. */
 const fillAddress = (to, record = {}) => {
 	if (to.kind === "record") {
 		const part = (value) => typeof value === "string" ? fill(value, record) : value;
@@ -20,6 +21,10 @@ const fillAddress = (to, record = {}) => {
 			key: Array.isArray(to.key) ? to.key.map(part) : part(to.key)
 		};
 	}
+	if (to.kind === "create") return to.values ? {
+		...to,
+		values: Object.fromEntries(Object.entries(to.values).map(([name, value]) => [name, fill(value, record)]))
+	} : to;
 	if (to.kind !== "list") return to;
 	return {
 		...to,

package/dist/app-address.js

@@ -35,7 +35,7 @@ const listQuery = (address) => {
 const appPath = (address, basePath = "") => {
 	switch (address.kind) {
 		case "page": return `${basePath}/${encodeURIComponent(address.page)}`;
-		case "create": return `${basePath}/${encodeURIComponent(address.resource)}/${addressWords.create}`;
+		case "create": return `${basePath}/${encodeURIComponent(address.resource)}/${addressWords.create}${valuesQuery(address.values)}`;
 		case "record": return `${basePath}/${encodeURIComponent(address.resource)}/${encodeURIComponent(encodeKey(address.key))}`;
 		case "list": return `${basePath}/${encodeURIComponent(address.resource)}${listQuery(address)}`;
 	}
@@ -48,6 +48,10 @@ const decodeSegments = (pathname) => {
 		throw error;
 	}
 };
+const valuesQuery = (values = {}) => {
+	const text = new URLSearchParams(Object.entries(values).filter(([, value]) => value !== "")).toString();
+	return text ? `?${text}` : "";
+};
 const filterLayout = (value) => value === "bar" || value === "panel" ? value : void 0;
 /**
 * The address `pathAndQuery` (below the base path) shows, or `undefined` for anything else: the root, the app's own
@@ -63,10 +67,14 @@ const readAppPath = (pathAndQuery, pages) => {
 		kind: "page",
 		page: first
 	} : void 0;
-	if (second === addressWords.create) return {
-		kind: "create",
-		resource: first
-	};
+	if (second === addressWords.create) {
+		const values = Object.fromEntries([...url.searchParams].filter(([, value]) => value !== ""));
+		return {
+			kind: "create",
+			resource: first,
+			...Object.keys(values).length > 0 && { values }
+		};
+	}
 	if (second !== void 0) return {
 		kind: "record",
 		resource: first,

package/dist/model.d.ts

@@ -87,7 +87,8 @@ export type ListQuery = {
 export type FilterLayout = 'bar' | 'panel';
 /**
  * A place in the app: a resource's list, one of its records, its create form, or a composed page. A record's `key` is
- * its one value or its parts, as the record API takes them; `readAppPath` gives it back as the API's text form.
+ * its one value or its parts, as the record API takes them; `readAppPath` gives it back as the API's text form. A create
+ * form's `values` fill in fields of the new record by name, as text (`{ listing_id: '42' }`).
  */
 export type AppAddress = {
   kind: 'list';
@@ -103,6 +104,7 @@ export type AppAddress = {
 } | {
   kind: 'create';
   resource: string;
+  values?: Readonly<Record<string, string>>;
 } | {
   kind: 'page';
   page: string;
@@ -136,6 +138,7 @@ export type ListDisplayModel = {
   name: string;
   label?: string;
   icon?: string;
+  image?: string;
   title?: string;
   subtitle?: string;
   badge?: string;

package/dist/view-displays.d.ts

@@ -17,12 +17,14 @@ type Naming = {
 export declare const tableDisplay = "table";
 export declare const displays: {
   /**
-   * A card per record: `title` (default: the view's title) over `subtitle`, `badge` drawn as a badge with its value
-   * labels, and a few small `meta` fields such as dates. With `card`, a component of the project or a plugin draws each
+   * A card per record: `image`, a file field shown as a picture across the card's top, then `title` (default: the
+   * view's title) over `subtitle`, `badge` drawn as a badge with its value labels, and a few small `meta` fields such as
+   * dates. With `card`, a component of the project or a plugin draws each
    * card's content instead, from the row of those fields (`{ row }`); without it, or when it throws, the card is the
    * built-in one. Named `cards` unless `name` says otherwise.
    */
   cards: (fields: {
+    image?: Ref;
     title?: Ref;
     subtitle?: Ref;
     badge?: Ref;

package/dist/view-displays.js

@@ -13,8 +13,9 @@ const customComponent = (component, where) => {
 };
 const displays = {
 	/**
-	* A card per record: `title` (default: the view's title) over `subtitle`, `badge` drawn as a badge with its value
-	* labels, and a few small `meta` fields such as dates. With `card`, a component of the project or a plugin draws each
+	* A card per record: `image`, a file field shown as a picture across the card's top, then `title` (default: the
+	* view's title) over `subtitle`, `badge` drawn as a badge with its value labels, and a few small `meta` fields such as
+	* dates. With `card`, a component of the project or a plugin draws each
 	* card's content instead, from the row of those fields (`{ row }`); without it, or when it throws, the card is the
 	* built-in one. Named `cards` unless `name` says otherwise.
 	*/
@@ -22,6 +23,7 @@ const displays = {
 		kind: "cards",
 		name: o.name ?? "cards",
 		...naming(o),
+		...fields.image && { image: fields.image.name },
 		...fields.title && { title: fields.title.name },
 		...fields.subtitle && { subtitle: fields.subtitle.name },
 		...fields.badge && { badge: fields.badge.name },
@@ -55,6 +57,7 @@ const displayErrors = (list) => {
 };
 /** Every field a display names: what it shows, and the field references in a custom display's props. */
 const displayFields = (display) => display.kind === "cards" ? [
+	display.image,
 	display.title,
 	display.subtitle,
 	display.badge,

package/dist/view.js

@@ -97,6 +97,7 @@ var ViewBuilder = class ViewBuilder {
 		for (const display of resource ? list?.displays ?? [] : []) {
 			const unknown = displayFields(display).find((name) => !Object.hasOwn(resource.fields, name));
 			if (unknown !== void 0) throw new Error(`View "${this.state.resource}": display "${display.name}" names field "${unknown}", which the resource does not have`);
+			if (display.kind === "cards" && display.image !== void 0 && resource.fields[display.image].type !== "file") throw new Error(`View "${this.state.resource}": display "${display.name}" shows "${display.image}" as its image, which is not a file field`);
 		}
 		const recentErrors = resource && nav?.recent ? navRecentErrors(nav.recent, resource) : [];
 		if (recentErrors.length > 0) throw new Error(`View "${this.state.resource}": nav.recent ${recentErrors.join("; ")}`);

package/package.json

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