@webx-ui/module-blocks 0.14.0 → 0.15.0

package/dist/BlocksField.d.ts

@@ -62,10 +62,10 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
         select: (key: string | null) => any;
         edit: () => any;
     }, import('vue').PublicProps, {
+        reload: number;
         hidden: string[];
         selected: string | null;
         compact: boolean;
-        reload: number;
     }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         bar: HTMLDivElement;
         box: HTMLDivElement;
@@ -91,10 +91,10 @@ declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {},
         refresh: () => void;
         open: () => boolean;
     }, {}, {}, {}, {
+        reload: number;
         hidden: string[];
         selected: string | null;
         compact: boolean;
-        reload: number;
     }> | null;
 }, any>;
 export default _default;

package/dist/BlocksPreview.d.ts

@@ -34,10 +34,10 @@ declare const _default: import('vue').DefineComponent<__VLS_Props, {
     onSelect?: ((key: string | null) => any) | undefined;
     onEdit?: (() => any) | undefined;
 }>, {
+    reload: number;
     hidden: string[];
     selected: string | null;
     compact: boolean;
-    reload: number;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
     bar: HTMLDivElement;
     box: HTMLDivElement;

package/dist/BlocksSiteBarTab.d.ts

@@ -0,0 +1,30 @@
+import { SiteBarContext } from '@webx-ui/module-admin';
+/**
+ * The «Blocks» tab of the panel on the site (WEBX_UI_SITE_BAR.md, §8–§9, SB4).
+ *
+ * Two states, like the constructor's narrow column: maps of the blocks, or one block's fields.
+ * The maps are the record's — the page behind the address — and the layout's regions', the
+ * header and the footer, each under its own name; a row under the pointer frames its block on the
+ * page. The pencil is the way from the page: with it on, a click on a block picks it there
+ * instead of following its link, whichever tree it belongs to.
+ *
+ * The form is the constructor's own — the block's schema through the same steps, drawn by the
+ * same renderer with the panel's field types — and its values are the draft's, never the
+ * site's: an edit goes into the draft of whatever holds the block, and a form that showed what
+ * is published would write over whatever a colleague prepared. «Save» writes the fields that
+ * changed and puts the block, drawn from the draft, in place of the old one on the page.
+ *
+ * The record's draft is published from the head of the bar; a region's — with its own buttons
+ * over its map and over the form of its block, since it is a draft of its own and goes on every
+ * page at once.
+ *
+ * The structure too (SB5): a block added — below another, at the end of a tree, inside a
+ * container — duplicated, moved up or down, hidden, shown or deleted, each one an operation of the
+ * agent's dictionary into the same draft. The picker is the constructor's, held to the same rules
+ * of the place; what cannot be done right now is greyed with the reason rather than missing.
+ */
+type __VLS_Props = {
+    context: SiteBarContext;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/BlocksTree.d.ts

@@ -25,21 +25,21 @@ type __VLS_Props = {
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     add: (parentKey: string | null, field: string | null, node: ScreenNode | null, index?: number | undefined) => any;
-    remove: (key: string) => any;
+    move: (key: string) => any;
     duplicate: (key: string) => any;
+    remove: (key: string) => any;
     copy: (key: string) => any;
     paste: (parentKey: string | null, field: string | null, node: ScreenNode | null, index?: number | undefined) => any;
-    move: (key: string) => any;
     select: (key: string) => any;
     visibility: (key: string, hidden: boolean) => any;
     reorder: (parentKey: string | null, field: string | null, list: BlockNode[]) => any;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     onAdd?: ((parentKey: string | null, field: string | null, node: ScreenNode | null, index?: number | undefined) => any) | undefined;
-    onRemove?: ((key: string) => any) | undefined;
+    onMove?: ((key: string) => any) | undefined;
     onDuplicate?: ((key: string) => any) | undefined;
+    onRemove?: ((key: string) => any) | undefined;
     onCopy?: ((key: string) => any) | undefined;
     onPaste?: ((parentKey: string | null, field: string | null, node: ScreenNode | null, index?: number | undefined) => any) | undefined;
-    onMove?: ((key: string) => any) | undefined;
     onSelect?: ((key: string) => any) | undefined;
     onVisibility?: ((key: string, hidden: boolean) => any) | undefined;
     onReorder?: ((parentKey: string | null, field: string | null, list: BlockNode[]) => any) | undefined;

package/dist/RegionDraftNotice.d.ts

@@ -0,0 +1,28 @@
+import { SiteBarRegion } from './types';
+/**
+ * A region's unpublished draft in the panel on the site, with the buttons that publish it or
+ * throw it away.
+ *
+ * Drawn over the region's map and over the form of one of its blocks alike: the head of the bar
+ * speaks for the record only, so the form is where an editor who has just saved a block of the
+ * footer is looking — and a notice that only the map carried was found after a reload.
+ */
+type __VLS_Props = {
+    region: SiteBarRegion;
+    /** This region's publication or discard is under way. */
+    busy?: boolean;
+    /** Another region's is: one at a time, since each reloads the page. */
+    blocked?: boolean;
+    /** Why the publication was refused — the blocks of the draft that fail. */
+    refusals?: string[];
+    /** The region's draft drawn on this page: after a reload the page shows the site again. */
+    preview?: string | null;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    publish: () => any;
+    discard: () => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onPublish?: (() => any) | undefined;
+    onDiscard?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { AdminContext } from '@webx-ui/module-admin';
-import { BlockExport, BlockImportRow, BlockInput, BlockList, BlockType, BlockUsage, BlockVersion, BlockNode, BlockVersionMeta, RegionAdopted, RegionDetail, RegionRow, RegionVersion, RenderInput, RenderResult } from './types';
+import { BlockExport, BlockImportRow, BlockInput, BlockList, BlockType, BlockUsage, BlockVersion, BlockNode, BlockVersionMeta, RegionAdopted, RegionDetail, RegionRow, RegionVersion, RenderInput, RenderResult, SiteBarBlockEdit, SiteBarBlockEdited, SiteBarBlocks } from './types';
 export interface BlocksApi {
     /** Every type, without content: the section's list. */
     list(): Promise<BlockType[]>;
@@ -40,6 +40,17 @@ export interface BlocksApi {
 }
 /** Everything under `/blocks`, below the panel's API path. */
 export declare function createBlocksApi(admin: AdminContext): BlocksApi;
+export interface SiteBarBlocksApi {
+    /** A record's blocks: the draft's, or the site's when there is no draft. */
+    read(type: string, id: number | string): Promise<SiteBarBlocks>;
+    /**
+     * One block's fields into the record's draft. A revision that moved is answered 409 — the
+     * error's body names who moved it.
+     */
+    edit(type: string, id: number | string, input: SiteBarBlockEdit): Promise<SiteBarBlockEdited>;
+}
+/** The two addresses of the «Blocks» tab of the panel on the site, by the record's address type. */
+export declare function createSiteBarBlocksApi(admin: AdminContext): SiteBarBlocksApi;
 export interface RegionsApi {
     /** Every region the site's config declares, saved or not. */
     list(): Promise<RegionRow[]>;

package/dist/i18n.d.ts

@@ -1,2 +1,8 @@
+import { I18n } from '@webx-ui/module-admin';
+/**
+ * Puts this package's English under a panel's dictionary, once per panel. For what runs outside
+ * a component's setup — the label of a tab on the panel on the site is asked for by the frame.
+ */
+export declare function seedBlocksMessages(i18n: I18n): void;
 /** Puts this package's English under the panel's dictionary, once per panel. */
 export declare function useBlocksMessages(): void;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { blocks, regions, type BlocksOptions, type RegionsOptions } from './module';
-export { createBlocksApi, createRegionsApi, type BlocksApi, type RegionsApi } from './api';
+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';
@@ -7,6 +7,7 @@ export { lintBlock, undeclared } from './lint';
 export { findRange, highlightBlock, replaceBlock, stageDocument } from './frame';
 export { callTag, formSchema, kindOf } from './schema';
 export { default as WxBlocks } from './BlocksField';
+export { default as WxBlocksSiteBarTab } from './BlocksSiteBarTab';
 export { default as WxBlocksPage } from './BlocksPage';
 export { default as WxBlockEditorPage } from './BlockEditorPage';
 export { default as WxBlockPicker } from './BlockPicker';