@protobase/schema 0.23.3 → 0.23.4

package/dist/address-errors.d.ts

@@ -7,11 +7,13 @@ export type AddressCheck = {
   pages?: ReadonlySet<string>;
   /** The resource of the record the link sits on, whose fields its `{field}` placeholders name. */
   source?: ResourceModel;
+  /** The resources whose view opens a create page of the app's own, which reads a create address's values whatever their names. */
+  createPages?: ReadonlySet<string>;
 };
 /**
  * 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, 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.
+ * have, unless its view opens a create page, which reads them. Empty when it can be followed.
  */
-export declare const addressErrors: (to: AppAddress, { models, pages, source }: AddressCheck) => string[];
+export declare const addressErrors: (to: AppAddress, { models, pages, source, createPages }: AddressCheck) => string[];
 //#endregion

package/dist/address-errors.js

@@ -32,9 +32,9 @@ 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, 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.
+* have, unless its view opens a create page, which reads them. Empty when it can be followed.
 */
-const addressErrors = (to, { models, pages, source }) => {
+const addressErrors = (to, { models, pages, source, createPages }) => {
 	const placeholders = addressPlaceholders(to).flatMap((name) => {
 		if (!source) return [`"{${name}}" takes a value from the record, but the link sits on none`];
 		return Object.hasOwn(source.fields, name) ? [] : [`"{${name}}" is not a field of ${source.name}`];
@@ -46,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" && createPages?.has(to.resource)) return placeholders;
 			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 [

package/dist/model.d.ts

@@ -112,6 +112,8 @@ export type ResourceModel = {
   history?: true;
   /** Whether people who may read its records comment on them (`.comments()`). */
   comments?: true;
+  /** Whether open pages refresh as soon as its records change (`.live()`). */
+  live?: true;
 };
 /** What happened to a record: `delete` and `undelete` include setting and clearing a soft delete field. */
 export type EventOperation = 'create' | 'update' | 'delete' | 'undelete';

package/dist/resource-model.d.ts

@@ -19,5 +19,6 @@ export type ResourceState = {
   events?: EventSpec[];
   history?: boolean;
   comments?: boolean;
+  live?: boolean;
 };
 //#endregion

package/dist/resource-model.js

@@ -62,6 +62,7 @@ const assembleModel = (state) => {
 		...state.owner && { owner: state.owner },
 		...state.history && { history: true },
 		...state.comments && { comments: true },
+		...state.live && { live: true },
 		...state.position && { position: { ...state.position } }
 	};
 };

package/dist/resource.d.ts

@@ -109,6 +109,12 @@ export declare class ResourceBuilder<F extends FieldsInput = {}, K = never> {
    * [Record comments](website/src/content/docs/reference/comments.mdx).
    */
   comments(): ResourceBuilder<F, K>;
+  /**
+   * Refreshes the pages open on its records and lists as soon as they change, from the API or elsewhere: the server
+   * tells each open app which records changed, never their values, and the app reads them again as its user. See
+   * [Live updates](website/src/content/docs/reference/live.mdx).
+   */
+  live(): ResourceBuilder<F, K>;
   /** The code predicates (`match`) of its events, by event name. */
   eventMatches(): Record<string, EventMatch<any>>;
   /**

package/dist/resource.js

@@ -128,6 +128,14 @@ var ResourceBuilder = class ResourceBuilder {
 	comments() {
 		return this.next({ comments: true });
 	}
+	/**
+	* Refreshes the pages open on its records and lists as soon as they change, from the API or elsewhere: the server
+	* tells each open app which records changed, never their values, and the app reads them again as its user. See
+	* [Live updates](website/src/content/docs/reference/live.mdx).
+	*/
+	live() {
+		return this.next({ live: true });
+	}
 	/** The code predicates (`match`) of its events, by event name. */
 	eventMatches() {
 		return eventMatches(this.toModel(), this.state.events ?? []);

package/package.json

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