@protobase/schema 0.15.1 → 0.15.3

package/dist/address-template.d.ts

@@ -13,4 +13,15 @@ export declare const fillAddress: (to: AppAddress, record?: Record<string, unkno
 export declare const leavesApp: (href: string) => boolean;
 /** Why an href cannot be a link's `href`: it points inside the app, which takes an address in `to`. */
 export declare const appHrefError: (href: string) => string | undefined;
+/** The field an action's href is made of alone, `{field}`: the record's value is the whole URL, as it is stored. */
+export declare const hrefField: (href: string) => string | undefined;
+/**
+ * Why a link action cannot be built: an `href` that points inside the app (one that is a single `{field}`, the URL the
+ * record holds, is fine), or `{host}` in the label of a link that goes `to` an address in the app, which has no host.
+ */
+export declare const linkActionError: (label: string, run: {
+  to: AppAddress;
+} | {
+  href: string;
+}) => string | undefined;
 //#endregion

package/dist/address-template.js

@@ -39,5 +39,15 @@ const fillAddress = (to, record = {}) => {
 const leavesApp = (href) => /^([a-z][a-z0-9+.-]*:|\/\/)/i.test(href);
 /** Why an href cannot be a link's `href`: it points inside the app, which takes an address in `to`. */
 const appHrefError = (href) => leavesApp(href) ? void 0 : `href "${href}" points inside the app; give the link \`to\` instead, an address such as { kind: 'record', resource: 'orders', key: '{order_id}' }`;
+/** The field an action's href is made of alone, `{field}`: the record's value is the whole URL, as it is stored. */
+const hrefField = (href) => /^\{([A-Za-z_][A-Za-z0-9_]*)\}$/.exec(href)?.[1];
+/**
+* Why a link action cannot be built: an `href` that points inside the app (one that is a single `{field}`, the URL the
+* record holds, is fine), or `{host}` in the label of a link that goes `to` an address in the app, which has no host.
+*/
+const linkActionError = (label, run) => {
+	if ("href" in run) return hrefField(run.href) ? void 0 : appHrefError(run.href);
+	return label.includes("{host}") ? "the label names {host}, which only a link with an href has" : void 0;
+};
 //#endregion
-export { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp };
+export { addressPlaceholders, appHrefError, fillAddress, hrefField, hrefPlaceholders, leavesApp, linkActionError };

package/dist/fields/file.js

@@ -1,6 +1,9 @@
 import { z } from "zod";
 //#region src/fields/file.ts
-/** A file column holds `{provider}:{path}?name=…&size=…` as text; writes send a ticket from `:upload` instead. */
+/**
+* A file column holds `{provider}:{path}?name=…&size=…` as text, or an https URL with `.externalUrls()`; writes send a
+* ticket from `:upload` instead.
+*/
 const file = {
 	type: "file",
 	constraints: [],

package/dist/file-field.d.ts

@@ -27,6 +27,12 @@ export declare class FileField<V> extends Field<V> {
    * format: 'webp' } }`. `{ original }` stores that image instead of the upload. Other files get none.
    */
   variants(variants: Record<string, ImageVariant>, options?: ImageVariantOptions): FileField<V>;
+  /**
+   * Also takes an https URL of a file elsewhere, such as `https://images.example.com/photos/42.jpg`, stored as it is:
+   * never uploaded, without variants, and drawn from that address. See
+   * [External URLs](website/src/content/docs/reference/files.mdx#external-urls).
+   */
+  externalUrls(): FileField<V>;
   /** The column is nullable: the field may hold no file. */
   optional(): FileField<V | null>;
   /** Never written through the API. */

package/dist/file-field.js

@@ -49,6 +49,14 @@ var FileField = class FileField extends Field {
 			...options.original && { original: checkedVariant("The original", options.original) }
 		});
 	}
+	/**
+	* Also takes an https URL of a file elsewhere, such as `https://images.example.com/photos/42.jpg`, stored as it is:
+	* never uploaded, without variants, and drawn from that address. See
+	* [External URLs](website/src/content/docs/reference/files.mdx#external-urls).
+	*/
+	externalUrls() {
+		return this.withFile({ external: true });
+	}
 	/** The column is nullable: the field may hold no file. */
 	optional() {
 		return this.with({ nullable: true });

package/dist/files/file-options.d.ts

@@ -64,6 +64,8 @@ export type FileOptions = {
   variants?: Record<string, ImageVariant>;
   /** The image stored instead of the upload (`.variants()`' `original`). */
   original?: ImageVariant;
+  /** Whether a value may also be an https URL of a file elsewhere (`.externalUrls()`). */
+  external?: true;
 };
 /** Bytes from a number or text such as `10 MB` (decimal units) or `5 MiB` (binary units). */
 export declare const parseSize: (size: number | string) => number;

package/dist/internal.d.ts

@@ -10,8 +10,8 @@ import { SearchTerm, matchedSearchField, matchesSearch, searchTerms, termMatches
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
 import { PluginHost, PluginRequirement, inRange, pluginProblem } from "./plugin-version.js";
 import { redactSecrets } from "./redact-secrets.js";
-import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp } from "./address-template.js";
+import { addressPlaceholders, appHrefError, fillAddress, hrefField, hrefPlaceholders, leavesApp, linkActionError } from "./address-template.js";
 import { AddressCheck, addressErrors } from "./address-errors.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, cardPhotoLimit, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };
+export { type AddressCheck, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type SearchTerm, addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, cardPhotoLimit, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, leavesApp, linkActionError, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };

package/dist/internal.js

@@ -2,7 +2,7 @@ import { checkedAccept, checkedProvider, parseSize } from "./files/file-options.
 import { matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
 import { checkEventFilter } from "./events/event-models.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
-import { addressPlaceholders, appHrefError, fillAddress, hrefPlaceholders, leavesApp } from "./address-template.js";
+import { addressPlaceholders, appHrefError, fillAddress, hrefField, hrefPlaceholders, leavesApp, linkActionError } from "./address-template.js";
 import { fieldRefsIn, isFieldRef, markFieldRefs, unmarkFieldRefs } from "./field-ref.js";
 import { cardPhotoLimit, displayFields, tableDisplay } from "./view-displays.js";
 import { bottomBarFor } from "./bottom-bar.js";
@@ -14,4 +14,4 @@ import { redactSecrets } from "./redact-secrets.js";
 import { addressErrors } from "./address-errors.js";
 import { applyAssistantEvent, emptyAssistantState } from "./assistant/apply-event.js";
 import { readEventStream } from "./assistant/event-stream.js";
-export { addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, cardPhotoLimit, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefPlaceholders, inRange, isFieldRef, leavesApp, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };
+export { addressErrors, addressPlaceholders, appHrefError, applyAssistantEvent, bottomBarFor, cardPhotoLimit, checkEventFilter, checkedAccept, checkedProvider, decodeKey, defaultRecentLimit, displayFields, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, hrefField, hrefPlaceholders, inRange, isFieldRef, leavesApp, linkActionError, markFieldRefs, matchedSearchField, matchesSearch, navRecentErrors, parseSize, pluginProblem, pruneByShape, readEventStream, redactSecrets, searchTerms, shapes, statusTones, tableDisplay, termMatches, unmarkFieldRefs, webhookResources };

package/dist/model.d.ts

@@ -61,6 +61,8 @@ export type FileFieldModel = {
   variants?: Record<string, ImageVariant>;
   /** What is stored instead of an uploaded image, when the upload is not kept. */
   original?: ImageVariant;
+  /** Whether a value may also be an https URL of a file elsewhere, drawn and linked as it is (`.externalUrls()`). */
+  external?: true;
 };
 /** `digitsEnd`: only the end of the value's digits, spaces, `+` and dashes ignored (phone numbers). */
 export type SearchMatch = 'digitsEnd';
@@ -583,9 +585,12 @@ export type ActionRun = {
   /** The address, with `{field}` replaced by the record's values. */
   to: AppAddress;
 } | {
-  /** Opens a link that leaves the app. */
+  /** Opens a link that leaves the app, an `https:` or `http:` one in a new tab without the referrer. */
   kind: 'link';
-  /** The link (`https:`, `mailto:`), with `{field}` replaced by the record's values, percent-encoded. */
+  /**
+   * The link (`https:`, `mailto:`), with `{field}` replaced by the record's values, percent-encoded; or only `{field}`,
+   * the `https:` or `http:` URL the record holds, without which the action does not show.
+   */
   href: string;
 };
 /** A named action of a view (`.actions((a) => ...)`); see [Named actions](website/src/content/docs/reference/layouts.md#named-actions). */
@@ -594,7 +599,7 @@ export type ActionModel = {
   name: string;
   /** The button's label. */
   label: string;
-  /** The button's icon: `bed`, `file-text`, `ruler`, `send` or `wallet`; another name shows a lightning bolt. */
+  /** The button's icon: `bed`, `bell`, `bookmark`, `external-link`, `file-text`, `heart`, `ruler`, `send` or `wallet`; another name shows a lightning bolt. */
   icon?: string;
   /** The question the button asks before it runs the action. */
   confirm?: string;

package/dist/resource-model.js

@@ -38,7 +38,8 @@ const fieldModel = (name, field) => {
 			...writtenFields(meta.file).length > 0 && { derive: writtenFields(meta.file) },
 			...meta.file.placeholder !== void 0 && { placeholder: meta.file.placeholder },
 			...meta.file.variants && Object.keys(meta.file.variants).length > 0 && { variants: structuredClone(meta.file.variants) },
-			...meta.file.original && { original: { ...meta.file.original } }
+			...meta.file.original && { original: { ...meta.file.original } },
+			...meta.file.external && { external: true }
 		} }
 	};
 };

package/dist/view-actions.d.ts

@@ -19,8 +19,10 @@ export declare const actions: {
   remove: (name: string, o: ActionOptions) => ActionModel;
   /**
    * Goes `to` an address in the app, such as `{ kind: 'record', resource: 'orders', key: '{order_id}' }`, or opens an
-   * `href` that leaves it (`https:`, `mailto:`); `{field}` is replaced by the record's value. A path in the app is
-   * refused as an `href`, so every address in the app is written one way.
+   * `href` that leaves it (`https:`, `mailto:`); `{field}` is replaced by the record's value. An `https:` or `http:` link
+   * opens in a new tab without the referrer. An href that is only `{field}`, such as `'{website}'`, opens the URL the
+   * record holds, and the button shows only when it is an `https:` or `http:` URL; `{host}` in the label becomes its host,
+   * as in `'View on {host}'`. A path in the app is refused as an `href`, so every address in the app is written one way.
    */
   link: (name: string, o: Omit<ActionOptions, "confirm"> & ({
     to: AppAddress;

package/dist/view-actions.js

@@ -1,4 +1,4 @@
-import { appHrefError } from "./address-template.js";
+import { linkActionError } from "./address-template.js";
 //#region src/view-actions.ts
 const named = (name, o) => ({
 	name,
@@ -25,10 +25,14 @@ const actions = {
 	}),
 	/**
 	* Goes `to` an address in the app, such as `{ kind: 'record', resource: 'orders', key: '{order_id}' }`, or opens an
-	* `href` that leaves it (`https:`, `mailto:`); `{field}` is replaced by the record's value. A path in the app is
-	* refused as an `href`, so every address in the app is written one way.
+	* `href` that leaves it (`https:`, `mailto:`); `{field}` is replaced by the record's value. An `https:` or `http:` link
+	* opens in a new tab without the referrer. An href that is only `{field}`, such as `'{website}'`, opens the URL the
+	* record holds, and the button shows only when it is an `https:` or `http:` URL; `{host}` in the label becomes its host,
+	* as in `'View on {host}'`. A path in the app is refused as an `href`, so every address in the app is written one way.
 	*/
 	link: (name, o) => {
+		const error = linkActionError(o.label, o);
+		if (error) throw new Error(`Action "${name}": ${error}`);
 		if ("to" in o) return {
 			...named(name, o),
 			run: {
@@ -36,8 +40,6 @@ const actions = {
 				to: structuredClone(o.to)
 			}
 		};
-		const error = appHrefError(o.href);
-		if (error) throw new Error(`Action "${name}": ${error}`);
 		return {
 			...named(name, o),
 			run: {

package/package.json

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