@webx-ui/module-blocks 0.10.5 → 0.11.1

package/dist/BlockPicker.d.ts

@@ -16,9 +16,12 @@ type __VLS_Props = {
     groups?: string[];
     /** Where a person with the right can go and make a type. */
     blocksPath?: string | null;
+    /** What the top level is called in `allowed_in`: a page, or a layout region. */
+    root?: string;
 };
 declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
     allow: string[] | null;
+    root: string;
     groups: string[];
     parent: BlockType | null;
     tree: BlockNode[];

package/dist/RegionEditorPage.d.ts

@@ -0,0 +1,7 @@
+type __VLS_Props = {
+    base?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/RegionHistory.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+export default _default;

package/dist/RegionPagePicker.d.ts

@@ -0,0 +1,16 @@
+import { LinkValue } from '@webx-ui/module-admin';
+export interface RegionPlace {
+    /** The site path the preview draws, `/` for the home page. */
+    path: string;
+    /** What was chosen, so reopening the picker shows it chosen. `null` — the home page. */
+    link: LinkValue | null;
+}
+type __VLS_PublicProps = {
+    modelValue: RegionPlace;
+};
+declare const _default: import('vue').DefineComponent<__VLS_PublicProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:modelValue": (value: RegionPlace) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_PublicProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: RegionPlace) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/RegionsPage.d.ts

@@ -0,0 +1,7 @@
+type __VLS_Props = {
+    base?: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    base: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { AdminContext } from '@webx-ui/module-admin';
-import { BlockInput, BlockList, BlockType, BlockUsage, BlockVersion, BlockVersionMeta, RenderInput, RenderResult } from './types';
+import { BlockInput, BlockList, BlockType, BlockUsage, BlockVersion, BlockNode, BlockVersionMeta, RegionAdopted, RegionDetail, RegionRow, RegionVersion, RenderInput, RenderResult } from './types';
 export interface BlocksApi {
     /** Every type, without content: the section's list. */
     list(): Promise<BlockType[]>;
@@ -24,3 +24,27 @@ export interface BlocksApi {
 }
 /** Everything under `/blocks`, below the panel's API path. */
 export declare function createBlocksApi(admin: AdminContext): BlocksApi;
+export interface RegionsApi {
+    /** Every region the site's config declares, saved or not. */
+    list(): Promise<RegionRow[]>;
+    get(name: string): Promise<RegionDetail>;
+    /**
+     * Save the draft. Refused with a 409 when the revision is not the current one — the error's
+     * body is a {@link RegionConflict} carrying the revision to write over.
+     */
+    save(name: string, input: {
+        blocks: BlockNode[];
+        revision?: string;
+    }): Promise<RegionDetail>;
+    publish(name: string): Promise<RegionDetail>;
+    /** Off the site: the code's view comes back, the blocks stay as the draft. */
+    unpublish(name: string): Promise<RegionDetail>;
+    discardDraft(name: string): Promise<RegionDetail>;
+    versions(name: string): Promise<RegionVersion[]>;
+    /** An old publication becomes the draft; putting it on the site is a separate step. */
+    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>;
+}
+/** Everything under `/regions`, below the panel's API path. */
+export declare function createRegionsApi(admin: AdminContext): RegionsApi;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export { blocks, type BlocksOptions } from './module';
-export { createBlocksApi, type BlocksApi } from './api';
+export { blocks, regions, type BlocksOptions, type RegionsOptions } from './module';
+export { createBlocksApi, createRegionsApi, type BlocksApi, type RegionsApi } from './api';
 export { blocksMessages } from './messages';
-export { blocksPreviewKey, provideBlocksPreview, useBlocksPreview, type BlocksPreview, } from './preview';
+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 { lintBlock, undeclared } from './lint';
 export { findRange, highlightBlock, replaceBlock, stageDocument } from './frame';
@@ -12,4 +12,6 @@ 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 type { BlockContent, BlockInput, BlockKind, BlockList, BlockNode, BlockParent, BlockSource, BlocksMeta, BlockThumbnail, BlockType, BlockUsage, BlockVersion, BlockVersionMeta, DeclaredComponent, Lint, PublishRefusal, RenderInput, RenderResult, ShapeField, } from './types';
+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';