@webx-ui/module-blocks 0.15.0 → 0.16.0

package/dist/BlocksField.d.ts

@@ -51,18 +51,20 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
         reload?: number;
         compact?: boolean;
         hidden?: string[];
+        region?: string | null;
     }> & Readonly<{
-        onSelect?: ((key: string | null) => any) | undefined;
         onEdit?: (() => any) | undefined;
+        onSelect?: ((key: string | null) => any) | undefined;
     }>, {
         replace: (key: string, html: string) => boolean;
         refresh: () => void;
         open: () => boolean;
     }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-        select: (key: string | null) => any;
         edit: () => any;
+        select: (key: string | null) => any;
     }, import('vue').PublicProps, {
         reload: number;
+        region: string | null;
         hidden: string[];
         selected: string | null;
         compact: boolean;
@@ -83,15 +85,17 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
         reload?: number;
         compact?: boolean;
         hidden?: string[];
+        region?: string | null;
     }> & Readonly<{
-        onSelect?: ((key: string | null) => any) | undefined;
         onEdit?: (() => any) | undefined;
+        onSelect?: ((key: string | null) => any) | undefined;
     }>, {
         replace: (key: string, html: string) => boolean;
         refresh: () => void;
         open: () => boolean;
     }, {}, {}, {}, {
         reload: number;
+        region: string | null;
         hidden: string[];
         selected: string | null;
         compact: boolean;

package/dist/BlocksPreview.d.ts

@@ -19,6 +19,11 @@ type __VLS_Props = {
     compact?: boolean;
     /** Keys of the blocks switched off: marked in the page until it reloads without them. */
     hidden?: string[];
+    /**
+     * A region to frame and scroll to: a shared block, which is wherever the page placed it and
+     * not where a header always is — down the page under the content, more often than not.
+     */
+    region?: string | null;
 };
 /** Swap one block's markup in place; false when the page has to be reloaded instead. */
 declare function replace(key: string, html: string): boolean;
@@ -28,13 +33,14 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
     refresh: typeof refresh;
     open: () => boolean;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-    select: (key: string | null) => any;
     edit: () => any;
+    select: (key: string | null) => any;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
-    onSelect?: ((key: string | null) => any) | undefined;
     onEdit?: (() => any) | undefined;
+    onSelect?: ((key: string | null) => any) | undefined;
 }>, {
     reload: number;
+    region: string | null;
     hidden: string[];
     selected: string | null;
     compact: boolean;

package/dist/FragmentField.d.ts

@@ -0,0 +1,17 @@
+import { RegionRow } from './types';
+type __VLS_Props = {
+    modelValue?: string | null;
+    disabled?: boolean;
+    /** The shared blocks to choose from. Fetched from the panel when absent — a demo hands them in. */
+    fragments?: RegionRow[] | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: string | null) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:modelValue"?: ((value: string | null) => any) | undefined;
+}>, {
+    modelValue: string | null;
+    disabled: boolean;
+    fragments: RegionRow[] | null;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/api.d.ts

@@ -19,6 +19,8 @@ export interface BlocksApi {
     }): Promise<BlockType>;
     render(id: number, input?: RenderInput): Promise<RenderResult>;
     usage(id: number): Promise<BlockUsage[]>;
+    /** The shared blocks a page may place, with their state; open to whoever reads the catalog. */
+    fragments(): Promise<RegionRow[]>;
     versions(id: number): Promise<BlockVersionMeta[]>;
     version(id: number, number: number): Promise<BlockVersion>;
     restore(id: number, number: number): Promise<BlockType>;
@@ -73,6 +75,11 @@ export interface RegionsApi {
     restoreVersion(name: string, number: number): Promise<RegionDetail>;
     /** The fallback view made into a block type, and one of it put into the draft. */
     adopt(name: string): Promise<RegionAdopted>;
+    /**
+     * A shared block's published tree with fresh keys, to put in a page in its place. Writes nothing;
+     * 409 while the shared block is not published.
+     */
+    copy(name: string): Promise<BlockNode[]>;
 }
 /** Everything under `/regions`, below the panel's API path. */
 export declare function createRegionsApi(admin: AdminContext): RegionsApi;

package/dist/content.d.ts

@@ -44,6 +44,11 @@ export declare function cloneNode(node: BlockNode): BlockNode;
  * save says so.
  */
 export declare function setHidden(tree: BlockNode[], key: string, hidden: boolean): BlockNode[];
+/**
+ * One block taken out and others put where it stood, in its list — what «Make it this page's own»
+ * does to a shared block. The tree as it was when the key is not in it.
+ */
+export declare function swapNode(tree: BlockNode[], key: string, nodes: BlockNode[]): BlockNode[];
 export declare function insertNode(tree: BlockNode[], parentKey: string | null, field: string | null, index: number, node: BlockNode): BlockNode[];
 export declare function removeNode(tree: BlockNode[], key: string): BlockNode[];
 export declare function updateValues(tree: BlockNode[], key: string, values: Record<string, unknown>): BlockNode[];

package/dist/frame.d.ts

@@ -15,14 +15,44 @@ export interface MarkerRange {
 }
 /** The pair of markers around a block, or null when the page does not hold it. */
 export declare function findRange(root: Node, key: string): MarkerRange | null;
+/**
+ * The pair around a region — `<!--wx-region:name-->` — which the region's own preview prints
+ * whatever the region holds, its fallback included.
+ */
+export declare function findRegion(root: Node, name: string): MarkerRange | null;
 /**
  * Swap the block's markup — markers included, since the new HTML carries its own — and let
  * the runtime mount whatever script the new markup needs. False when the key is not on the
  * page, which means the page has to be reloaded rather than patched.
  */
 export declare function replaceBlock(doc: Document, key: string, html: string): boolean;
-/** The first element a block prints — where a highlight goes. */
+/**
+ * The element a block is pointed at by — the outline, the scroll: the first one it prints that
+ * takes room on the page. One that draws nothing at all, or where the layout cannot be measured,
+ * gives the first it prints that could.
+ */
 export declare function blockElement(root: Node, key: string): Element | null;
+/**
+ * Where a region stands on the page: one box around everything it printed, in the page's own
+ * coordinates. Null when the page does not print it, or it printed nothing that takes room.
+ */
+export declare function regionRect(doc: Document, name: string): {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+} | null;
+export declare const REGION_FRAME_ID = "wx-preview-region";
+/**
+ * Draw a frame around a region of the page, or take it away (null).
+ *
+ * A box laid over the page rather than a class on an element, as a block has: a region is any
+ * number of blocks side by side, and wrapping them in an element of ours would break the site's
+ * own rules — `.site-main > section` stops matching the moment there is a `div` in between.
+ * Hangs off the root element and not the body, which a site may have positioned: there its top
+ * is the page's top, whatever the body's margins.
+ */
+export declare function frameRegion(doc: Document, name: string | null): void;
 /** Mark one block as the selected one, and nothing else. Null clears the selection. */
 export declare function highlightBlock(doc: Document, key: string | null): Element | null;
 export declare const HIDDEN_CLASS = "wx-preview-hidden";

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 export { blocks, regions, type BlocksOptions, type RegionsOptions } from './module';
 export { createBlocksApi, createRegionsApi, createSiteBarBlocksApi, type BlocksApi, type RegionsApi, type SiteBarBlocksApi, } from './api';
 export { blocksMessages } from './messages';
-export { blocksPreviewKey, blocksTopKey, provideBlocksPreview, provideBlocksTop, useBlocksPreview, type BlocksPreview, type BlocksTop, } from './preview';
-export { cloneNode, countType, insertNode, isNode, isNodeList, locate, makeNode, newKey, removeNode, replaceList, typesIn, updateValues, walk, type Located, } from './content';
+export { blocksFragmentKey, blocksPreviewKey, blocksTopKey, provideBlocksPreview, provideBlocksTop, useBlocksPreview, type BlocksFragmentHost, type BlocksPreview, type BlocksTop, } from './preview';
+export { cloneNode, countType, insertNode, isNode, isNodeList, locate, makeNode, newKey, removeNode, replaceList, swapNode, typesIn, updateValues, walk, type Located, } from './content';
 export { lintBlock, undeclared } from './lint';
-export { findRange, highlightBlock, replaceBlock, stageDocument } from './frame';
+export { findRange, findRegion, frameRegion, highlightBlock, regionRect, replaceBlock, stageDocument, } from './frame';
 export { callTag, formSchema, kindOf } from './schema';
 export { default as WxBlocks } from './BlocksField';
 export { default as WxBlocksSiteBarTab } from './BlocksSiteBarTab';
@@ -13,6 +13,7 @@ export { default as WxBlockEditorPage } from './BlockEditorPage';
 export { default as WxBlockPicker } from './BlockPicker';
 export { default as WxBlockThumb } from './BlockThumb';
 export { default as WxBlockStage } from './BlockStage';
+export { default as WxFragmentField } from './FragmentField';
 export { default as WxRegionsPage } from './RegionsPage';
 export { default as WxRegionEditorPage } from './RegionEditorPage';
-export type { BlockContent, BlockInput, BlockKind, BlockList, BlockNode, BlockParent, BlockSource, BlocksMeta, BlockThumbnail, BlockType, BlockUsage, BlockVersion, BlockVersionMeta, DeclaredComponent, Lint, PublishRefusal, RegionAdopted, RegionConflict, RegionDetail, RegionRow, RegionVersion, RenderInput, RenderResult, ShapeField, } from './types';
+export type { BlockContent, BlockInput, BlockKind, BlockList, BlockNode, BlockParent, BlockSource, BlocksMeta, BlockThumbnail, BlockType, BlockUsage, BlockVersion, BlockVersionMeta, DeclaredComponent, FragmentUse, Lint, PublishRefusal, RegionAdopted, RegionConflict, RegionDetail, RegionRow, RegionVersion, RenderInput, RenderResult, ShapeField, } from './types';