@antelopejs/interface-dms-builder 0.1.3 → 0.2.0

package/dist/catalog.d.ts

@@ -13,7 +13,7 @@ export interface DynamicSlots {
     idKey: string;
     labelKey?: string;
 }
-export type OptionWidget = "text" | "textarea" | "number" | "range" | "switch" | "select" | "segmented" | "icon" | "color" | "url" | "resource" | "field" | "dataType" | "query" | "dataSource" | "permission" | "json" | "block";
+export type OptionWidget = "text" | "textarea" | "number" | "range" | "switch" | "select" | "segmented" | "icon" | "color" | "url" | "resource" | "field" | "dataType" | "dataSource" | "permission" | "json" | "block";
 export type FieldAspect = "listable" | "searchable" | "sortable" | "filterable";
 export interface OptionUi {
     label?: string;

package/dist/structure.d.ts

@@ -2,6 +2,7 @@ import type { BlockPath, CategoryRef, PageRef } from "./addressing";
 import type { QueryStructure } from "./queries";
 import type { ResourceRef } from "./resources";
 export type PagePermission = Record<string, unknown>;
+export type PageLive = Record<string, unknown>;
 export interface PageMeta {
     ref: PageRef;
     id: string;
@@ -12,6 +13,7 @@ export interface PageMeta {
     description?: string;
     hidden?: boolean;
     permission?: PagePermission;
+    live?: PageLive;
     filepath: string;
 }
 export interface EditablePageMeta {
@@ -22,6 +24,7 @@ export interface EditablePageMeta {
     description?: string;
     hidden?: boolean;
     permission?: PagePermission;
+    live?: PageLive;
 }
 export interface BlockNode {
     path: BlockPath;
@@ -56,6 +59,8 @@ export interface CategorySummary {
     ref: CategoryRef;
     displayName: string;
     parent?: CategoryRef;
+    icon?: string;
+    order?: number;
 }
 export interface EditableCategoryMeta {
     displayName: string;

package/docs/2.addressing-and-structure.md

@@ -80,9 +80,10 @@ const category = await CreateCategory({
 | `description` | `string` | The page's description. |
 | `hidden` | `boolean` | Whether the page is hidden from the menu. |
 | `permission` | `PagePermission` | The permission guarding the page. |
+| `live` | `PageLive` | The page's Direct / Pause options, when it is live. |
 | `filepath` | `string` | The file the page is declared in, resolved by the builder's source index rather than by the runtime registry. |
 
-`hidden` and `permission` read back like any other field, as long as the page declares them literally. A `permission` built from a call or a reference — an `Action`, say — reads back as `undefined`: the builder reports only what it can also rewrite.
+`hidden`, `permission` and `live` read back like any other field, as long as the page declares them literally. A `permission` built from a call or a reference — an `Action`, say — reads back as `undefined`: the builder reports only what it can also rewrite.
 
 `PagePermission` mirrors the DMS `MenuOptions.permission`: a partial permission spec, whose fields are `id`, `title`, `icon`, `description`, `dependencies` and `defaultGranted`. A bare action id is *not* accepted — the DMS types the option as `Partial<Permission> | Action`, so a string would be written and then refused by the typecheck gate.
 
@@ -97,6 +98,8 @@ const permission: PagePermission = {
 
 The DMS also accepts an `Action` there. That is a live object rather than data, so it has no encoding in the builder: a page declaring one reads its permission back as `undefined`.
 
+`PageLive` mirrors the DMS `MenuOptions.live`: `maxRate`, `slowRateAfter`, `rememberKey`. Present, even empty (`{}`), the page is live — its blocks refetch through a Direct / Pause valve its `LiveToggle` switches; absent, they refetch on every event. Sent as `null` in a patch, it is taken off.
+
 ## Patch a Page's Metadata
 
 `EditablePageMeta` is the subset of `PageMeta` that `ConfigurePage` accepts as a patch: `displayName`, `icon`, `category`, `order`, `description`, `hidden` and `permission`. `ref`, `id` and `filepath` are not patchable — they follow from where the page lives.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/interface-dms-builder",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -37,7 +37,7 @@
     "prepack": "pnpm run build"
   },
   "devDependencies": {
-    "@antelopejs/interface-core": ">=0.1.1 <1.0.0",
+    "@antelopejs/interface-core": ">=0.2.0 <1.0.0",
     "release-it": "^19.2.4",
     "release-it-changelogen": "^0.1.0",
     "rimraf": "^6.1.3",