@protobase/layout 0.11.0 → 0.11.1

package/dist/component.d.ts

@@ -1,10 +1,17 @@
 import { Block, LayoutChildren } from "./node.js";
 //#region src/component.d.ts
+/** `plugin`: the plugin that provides the component at runtime, instead of the project's protobase.ui.tsx. */
+export type ComponentOptions = {
+  plugin?: string;
+};
 /**
  * Declares a custom component for layouts: `<UsageChart metric="cpu" />` becomes an element of type `UsageChart`,
  * which the app renders with the React component registered under that name. Its props must be static values too.
+ * With `plugin`, a plugin provides it, so `protobase build` does not look for it in protobase.ui.tsx.
  */
-export declare const component: <P extends object = Record<string, never>>(name: string) => Block<P & {
+export declare const component: <P extends object = Record<string, never>>(name: string, options?: ComponentOptions) => Block<P & {
   children?: LayoutChildren;
-}>;
+}> & {
+  readonly plugin?: string;
+};
 //#endregion

package/dist/component.js

@@ -5,11 +5,14 @@ const componentName = /^[A-Z][A-Za-z0-9]*$/;
 /**
 * Declares a custom component for layouts: `<UsageChart metric="cpu" />` becomes an element of type `UsageChart`,
 * which the app renders with the React component registered under that name. Its props must be static values too.
+* With `plugin`, a plugin provides it, so `protobase build` does not look for it in protobase.ui.tsx.
 */
-const component = (name) => {
+const component = (name, options = {}) => {
 	if (!componentName.test(name)) throw new Error(`Component name "${name}" must be PascalCase, such as UsageChart`);
 	if (Object.hasOwn(blockSpecs, name) || name === "Fragment") throw new Error(`"${name}" is a built-in block; give the custom component another name`);
-	return defineBlock(name, true);
+	if (options.plugin !== void 0 && options.plugin.trim() === "") throw new Error(`component('${name}') names an empty plugin; name the plugin that provides it`);
+	const block = defineBlock(name, true);
+	return options.plugin === void 0 ? block : Object.assign(block, { plugin: options.plugin });
 };
 //#endregion
 export { component };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Block, LayoutChild, LayoutChildren, LayoutNode, LayoutValue, isLayoutNode } from "./node.js";
 import { Action, ActionProps, ButtonVariant, Card, CardProps, CardRow, CardRowProps, DataProps, Elements, Field, FieldProps, Grid, GridProps, GridSpan, Link, LinkProps, ModalForm, ModalFormProps, Page, PageProps, Progress, ProgressProps, RecordCard, RecordCardProps, Show, ShowProps, Stat, StatProps, Table, TableProps } from "./blocks.js";
-import { component } from "./component.js";
+import { ComponentOptions, component } from "./component.js";
 import { PageDefinition, PageModel, PageOptions, isPageDefinition, page } from "./page.js";
 import { checkPages } from "./check-page.js";
 import { prunePage } from "./prune-page.js";
@@ -8,4 +8,4 @@ import { countedResource, evaluateCondition, parseCondition } from "./condition.
 import { PathStep, resolveFieldPath } from "./field-path.js";
 import { jsx_runtime_d_exports } from "./jsx-runtime.js";
 import { FieldRefValue, fieldRef } from "@protobase/schema";
-export { Action, type ActionProps, type Block, type ButtonVariant, Card, type CardProps, CardRow, type CardRowProps, type DataProps, type Elements, Field, type FieldProps, type FieldRefValue, Grid, type GridProps, type GridSpan, type LayoutChild, type LayoutChildren, type LayoutNode, type LayoutValue, Link, type LinkProps, ModalForm, type ModalFormProps, Page, type PageDefinition, type PageModel, type PageOptions, type PageProps, type PathStep, Progress, type ProgressProps, RecordCard, type RecordCardProps, Show, type ShowProps, Stat, type StatProps, Table, type TableProps, checkPages, component, countedResource, evaluateCondition, fieldRef, isLayoutNode, isPageDefinition, jsx_runtime_d_exports as jsxRuntime, page, parseCondition, prunePage, resolveFieldPath };
+export { Action, type ActionProps, type Block, type ButtonVariant, Card, type CardProps, CardRow, type CardRowProps, type ComponentOptions, type DataProps, type Elements, Field, type FieldProps, type FieldRefValue, Grid, type GridProps, type GridSpan, type LayoutChild, type LayoutChildren, type LayoutNode, type LayoutValue, Link, type LinkProps, ModalForm, type ModalFormProps, Page, type PageDefinition, type PageModel, type PageOptions, type PageProps, type PathStep, Progress, type ProgressProps, RecordCard, type RecordCardProps, Show, type ShowProps, Stat, type StatProps, Table, type TableProps, checkPages, component, countedResource, evaluateCondition, fieldRef, isLayoutNode, isPageDefinition, jsx_runtime_d_exports as jsxRuntime, page, parseCondition, prunePage, resolveFieldPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/layout",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Composed pages for Protobase, written as JSX that compiles to plain data, with its JSX runtime.",
   "license": "Apache-2.0",
   "repository": {
@@ -31,7 +31,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@protobase/schema": "0.11.0",
+    "@protobase/schema": "0.11.1",
     "aip-parsers": "^1.0.0"
   }
 }