@plaudit/gutenberg-api-extensions 2.94.2 → 2.96.0

package/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.96.0] - 2026-04-29
+### Added
+- `setAttributes` to `ActualBlockListBlockProps`
+
+### Removed
+- The `src` folder from the list of included files
+  - All it was doing was causing problems with contextual suggestions
+
+## [2.95.0] - 2026-04-28
+### Added
+- An entrypoint for `lib/useful-types` for use with rollup
+
 ## [2.94.2] - 2026-04-28
 ### Fixed
 - The `useful-types` export being incorrectly forced to a type-only export

package/dist/lib/useful-types.d.ts

@@ -18,10 +18,7 @@ export type ActualBlockEditProps = {
     name: BlockName;
     clientId: string;
 };
-export type ActualBlockListBlockProps = {
-    attributes: ActualBEPAttrs;
-    name: BlockName;
-    clientId: string;
+export type ActualBlockListBlockProps = ActualBlockEditProps & {
     className?: string;
     style?: Record<string, unknown>;
     wrapperProps?: Record<string, unknown>;

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@plaudit/gutenberg-api-extensions",
-  "version": "2.94.2",
+  "version": "2.96.0",
   "license": "SEE LICENSE IN LICENSE.md",
   "files": [
     "./dist",
     "./styles",
-    "./src",
     "CHANGELOG.md",
     "LICENSE.md",
     "README.md",
@@ -14,11 +13,12 @@
   "sideEffects": false,
   "exports": {
     ".": "./dist/index.js",
-    "./lib/plaudit-icons": "./dist/lib/plaudit-icons.js",
     "./blocks": "./dist/blocks/index.js",
     "./blocks/csnp-api": "./dist/blocks/csnp-api.js",
     "./blocks/snp-api": "./dist/blocks/snp-api.js",
-    "./controls": "./dist/controls/index.js"
+    "./controls": "./dist/controls/index.js",
+    "./lib/plaudit-icons": "./dist/lib/plaudit-icons.js",
+    "./lib/useful-types": "./dist/lib/useful-types.js"
   },
   "dependencies": {
     "@reduxjs/toolkit": "^2.11.2",

package/src/blocks/MoveError.ts

@@ -1,7 +0,0 @@
-import type {RawPath} from "./simple-native-property-api";
-
-export class MoveError extends Error {
-	constructor(message: string, path: RawPath, {from, to}: {from: number, to: number}|{from: string, to: string}) {
-		super(`${message}: ${path.join(".")}.{${from} => ${to}}`);
-	}
-}

package/src/blocks/PathError.ts

@@ -1,18 +0,0 @@
-import type {RawPath} from "./simple-native-property-api";
-
-export enum PathErrorType {
-	UNKNOWN,
-	UNEXPECTED_LEAF,
-	INSUFFICIENT_LENGTH
-}
-
-export class PathError extends Error {
-	constructor(
-		message: string,
-		public readonly path: RawPath,
-		public readonly errorIndex: number = path.length - 1,
-		public readonly errorType = PathErrorType.UNKNOWN
-	) {
-		super(`${message} Full Path: ${path.join('.')}; Error Path: ${path.slice(0, errorIndex + 1).join('.')}`);
-	}
-}

package/src/blocks/SNPFlexibleItemsListComponent.tsx

@@ -1,30 +0,0 @@
-import {useCallback} from "@wordpress/element";
-
-import type {FlexibleItemsListPropertyConfig} from "./csnp-api";
-import {type FlexibleItem, SortableFlexibleItemsControl} from "../controls";
-import {makeLaidOutPropertyRow} from "./layout/LaidOutPropertyRow";
-import {NodeContextWrapper, useNodeContext} from "./layout/NodeContext";
-import type {NonEmptyArray} from "../lib/useful-types";
-import type {CSNPControlComponentProps} from "./shared-internal-types";
-import type {HydratedSimpleNativeProperty, SNPControlSlots} from "./simple-native-property-api";
-
-export type SNPFlexibleItemsListComponentProps<T extends string> = CSNPControlComponentProps<FlexibleItemsListPropertyConfig<T>, FlexibleItem<T>[], {
-	availableTypes: NonEmptyArray<{value: T, label: string}>, emptyValues: {[key in T]?: FlexibleItem<T>}
-	hydratedProperties: {[key in T]: (HydratedSimpleNativeProperty|HydratedSimpleNativeProperty[])[]}
-}>&SNPControlSlots;
-export function SNPFlexibleItemsListComponent(
-	{config, availableTypes, emptyValues, hydratedProperties, value, Label, Messages}: SNPFlexibleItemsListComponentProps<string>
-) {
-	const context = useNodeContext("build a SNP List");
-	const onReorder = useCallback((oldIndex: number, newIndex: number) => context.moveNode({from: oldIndex, to: newIndex}), [context]);
-	const emptyValueBuilder = useCallback((type: string) => ({...emptyValues[type], type}), [emptyValues]);
-	const childRenderer = useCallback((datum: FlexibleItem, onDatumChange: (datum: FlexibleItem) => void, index: number) => {
-		return <NodeContextWrapper nodeName={index} children={(hydratedProperties[datum.type] ?? []).map(property => makeLaidOutPropertyRow({property}))} />;
-	}, [hydratedProperties]);
-
-	return <SortableFlexibleItemsControl
-		availableTypes={availableTypes} emptyValueBuilder={emptyValueBuilder}
-		value={value} min={config.min} max={config.max} Label={Label} Messages={Messages} help={config.help}
-		{...config.component} onAdd={context.addNode} onRemove={context.removeNode} onReorder={onReorder} children={childRenderer}
-	/>;
-}

package/src/blocks/SNPGroupComponent.tsx

@@ -1,38 +0,0 @@
-import {__experimentalToolsPanel as ToolsPanel} from "@wordpress/components";
-import {useCallback} from "@wordpress/element";
-
-import type {GroupPropertyCSNPConfig} from "./csnp-api";
-import type {Dict} from "../controls";
-import {LaidOutPropertyRow, makeLaidOutPropertyRow} from "./layout/LaidOutPropertyRow";
-import {useNodeContext} from "./layout/NodeContext";
-import type {CSNPControlComponentProps} from "./shared-internal-types";
-import type {SNPControlSlots} from "./simple-native-property-api";
-import type {HydratedLaidOutProperties} from "./simple-native-property-internal-shared";
-
-export type SNPGroupComponentProps = CSNPControlComponentProps<GroupPropertyCSNPConfig, Dict<any>, {hydratedProperties: HydratedLaidOutProperties}>&SNPControlSlots;
-export function SNPGroupComponent({config, hydratedProperties, Label, Messages}: SNPGroupComponentProps) {
-	if (config.interface === 'toolsPanel') {
-		const {value, setValue} = useNodeContext("render a toolsPanel");
-		return <>
-			<ToolsPanel
-				{...config.component}
-				className={config.component?.className ? `plaudit-snp-group-component ${config.component.className}` : "plaudit-snp-group-component"}
-				label={config.label}
-				resetAll={useCallback(resetAllFilters => {
-					setValue((resetAllFilters ?? []).reduce((q: any, filter) => filter(q), value))
-				}, [value, setValue])}
-			>
-				{...hydratedProperties.map(property => makeLaidOutPropertyRow({property, inToolsPanel: true}))}
-			</ToolsPanel>
-			<Messages/>
-		</>;
-	} else {
-		return <fieldset {...config.component} className={config.component?.className ? `plaudit-snp-group-component ${config.component.className}` : "plaudit-snp-group-component"}>
-			<legend><Label/></legend>
-			<div className="plaudit-snp-laid-out-properties-wrapper">
-				{...hydratedProperties.map(property => makeLaidOutPropertyRow({property}))}
-			</div>
-			<Messages/>
-		</fieldset>;
-	}
-}

package/src/blocks/SNPListComponent.tsx

@@ -1,25 +0,0 @@
-import {useCallback, useMemo} from "@wordpress/element";
-
-import type {ObjectListPropertyConfig} from "./csnp-api";
-import {type Dict, SortableItemsControl} from "../controls";
-import {LaidOutPropertyRow, makeLaidOutPropertyRow} from "./layout/LaidOutPropertyRow";
-import {NodeContextWrapper, useNodeContext} from "./layout/NodeContext";
-import type {CSNPControlComponentProps} from "./shared-internal-types";
-import type {HydratedSimpleNativeProperty, SNPControlSlots} from "./simple-native-property-api";
-
-export type SNPListComponentProps = CSNPControlComponentProps<ObjectListPropertyConfig, Dict<any>[], {
-	hydratedProperties: (HydratedSimpleNativeProperty|HydratedSimpleNativeProperty[])[]
-}>&SNPControlSlots;
-export function SNPListComponent({config, hydratedProperties, value, Label, Messages}: SNPListComponentProps) {
-	const context = useNodeContext("build a SNP List");
-	const onReorder = useCallback((oldIndex: number, newIndex: number) => context.moveNode({from: oldIndex, to: newIndex}), [context]);
-	const emptyValue = useMemo(() => config.emptyValue ?? {}, [config.emptyValue]);
-	const childRenderer = useCallback((datum: Dict<any>, onDatumChange: (datum: Dict<any>) => void, index: number) => {
-		return <NodeContextWrapper nodeName={index} children={hydratedProperties.map(property => makeLaidOutPropertyRow({property}))} />
-	}, [hydratedProperties]);
-
-	return <SortableItemsControl
-		value={value} min={config.min} max={config.max} Label={Label} Messages={Messages} help={config.help} emptyValue={emptyValue}
-		{...config.component} onAdd={context.addNode} onRemove={context.removeNode} onReorder={onReorder} onChange={context.setValue} children={childRenderer}
-	/>;
-}

package/src/blocks/SNPTreeContext.tsx

@@ -1,13 +0,0 @@
-import {createContext, useContext} from "@wordpress/element";
-
-import type {DataController} from "./simple-native-property-api";
-
-export const SNPTreeContext = createContext<DataController|undefined>(undefined);
-
-export function useSNPTreeContext(action: string) {
-	const SNPTreeContextValue = useContext(SNPTreeContext);
-	if (SNPTreeContextValue === undefined) {
-		throw new Error(`Cannot ${action} outside of a SNPTreeContext`);
-	}
-	return SNPTreeContextValue;
-}

package/src/blocks/basic-custom-block-bindings-support.tsx

@@ -1,248 +0,0 @@
-import apiFetch from "@wordpress/api-fetch"
-import {getBlockBindingsSources, type registerBlockBindingsSource} from "@wordpress/blocks";
-import {InspectorAdvancedControls, useBlockBindingsUtils} from "@wordpress/block-editor";
-import {
-	__experimentalToolsPanel as ToolsPanel,
-	__experimentalToolsPanelItem as ToolsPanelItem,
-	SelectControl, Spinner, TextControl, Tooltip
-} from '@wordpress/components';
-import {createHigherOrderComponent} from "@wordpress/compose";
-import {dispatch, select, useSuspenseSelect} from "@wordpress/data";
-import {store as editorStore} from "@wordpress/editor";
-import {memo, useMemo} from "@wordpress/element";
-import {addFilter} from "@wordpress/hooks";
-
-import {registerSimpleGutenbergApiEndpoint} from "../editor/simple-gutenberg-endpoints-api";
-import {store as endpointsStore} from "../editor/simple-gutenberg-endpoints-impl";
-import {store as apiExtensionsStore} from "../lib/gutenberg-api-extensions-state";
-import type {ActualBlockEditProps, BlockName, DbSource} from "../lib/useful-types";
-
-import {type ReactElement, Suspense} from "react";
-import {ErrorBoundary, FallbackProps} from "react-error-boundary";
-
-const BLOCK_BINDINGS_ALLOWED_BLOCKS: {[key: BlockName]: string[]} = {
-	'core/paragraph': ['content'],
-	'core/heading': ['content'],
-	'core/image': ['id', 'url', 'title', 'alt'],
-	'core/button': ['url', 'text', 'linkTarget', 'rel']
-};
-
-type CBBParams = {dbSources?: DbSource[]/*, supportsContext?: boolean*/};
-export function registerCustomBlockBindingsSource(args: Parameters<typeof registerBlockBindingsSource>[0]&CBBParams) {
-	installCustomBlockBindingsSupport();
-	dispatch(apiExtensionsStore).registerCustomBlockBindingsSource(args);
-}
-
-export function installCustomBlockBindingsSupport() {
-	if (installCustomBlockBindingsSupport.called) {
-		return;
-	}
-	installCustomBlockBindingsSupport.called = true;
-
-	registerSimpleGutenbergApiEndpoint(
-		"plaudit-base.custom-bindings.source.options",
-		data => apiFetch<Array<{id: number, title: string, type: string}>>({data, method: 'POST', path: "/plaudit/base/v1/custom-bindings/source/options"}),
-		{maxCachedResults: 20}
-	);
-
-	addFilter('editor.BlockEdit', 'plaudit/gutenberg-api-extensions/basic-custom-block-bindings-support',
-		createHigherOrderComponent(BlockEdit => function CustomBlockBindingsSupportBlockEdit(blockEditProps: ActualBlockEditProps) {
-			const availableBindingsList = BLOCK_BINDINGS_ALLOWED_BLOCKS[blockEditProps.name];
-			if (!availableBindingsList?.length) {
-				return <BlockEdit {...blockEditProps} />;
-			}
-			const {removeAllBlockBindings, updateBlockBindings} = useBlockBindingsUtils();
-			const currentPost = select(editorStore).getCurrentPost();
-			const bindingConfigs = useMemo(
-				() => {
-					return availableBindingsList.map((binding): [Parameters<typeof ToolsPanelItem>[0], BlockBindingToolProps] => {
-						return [
-							{
-								label: binding,
-								hasValue() {
-									return blockEditProps.attributes['metadata']?.['bindings']?.[binding] !== undefined;
-								},
-								onDeselect() {
-									updateBlockBindings({[binding]: undefined});
-								}
-							},
-							{
-								label: binding,
-								value: blockEditProps.attributes['metadata']?.['bindings']?.[binding],
-								currentPost,
-								binding
-							}
-						];
-					});
-				}, [blockEditProps.attributes, currentPost, availableBindingsList, updateBlockBindings]);
-			return <>
-				<BlockEdit {...blockEditProps} />
-				<InspectorAdvancedControls>
-					<ToolsPanel
-						label="Custom Block Bindings" resetAll={removeAllBlockBindings}
-						children={bindingConfigs.map(([bindingConfig, bbtConfig]) => (
-							<ToolsPanelItem key={bindingConfig.label} {...bindingConfig}>
-								<BlockBindingTool {...bbtConfig} />
-							</ToolsPanelItem>
-						))}
-					/>
-				</InspectorAdvancedControls>
-			</>;
-		}, 'plauditGutenbergApiExtensionsBasicBlockBindingsSupport')
-	);
-
-	type BlockBindingToolProps = {
-		value: { source: string, args: { [key: string]: any } } | undefined,
-		currentPost: any,
-		label: string,
-		binding: string
-	};
-
-	type SelectableOptions = Array<{ label: string, value: string, subfields: 'custom' | { label: string, value: string }[] }>;
-	type GetSelectableOptionsResponse = Array<{
-		label: string,
-		value: string,
-		subfields: 'custom' | { label: string, value: string }[],
-		disabled?: string | boolean,
-		binding: string
-	}>;
-	const BlockBindingTool = memo(({label, value, binding, currentPost}: BlockBindingToolProps) => {
-		const bindingSources = Object.entries(getBlockBindingsSources())
-			.filter(([key]) => key !== 'core/pattern-overrides' && key !== 'core/post-meta')
-			.map(([key, {label}]) => ({label, value: key}));
-		const {updateBlockBindings} = useBlockBindingsUtils();
-
-		return <fieldset className="custom-bindings-configuration-chain" style={{border: "revert", padding: "revert", margin: "revert"}}>
-			<legend>{label}</legend>
-			<SelectControl
-				key="source"
-				label="Source"
-				__next40pxDefaultSize
-				__nextHasNoMarginBottom
-				onChange={source => updateBlockBindings({[binding]: {source, args: {}}})}
-				options={[
-					{
-						disabled: true,
-						label: "Select a Binding Source",
-						value: ''
-					},
-					...bindingSources
-				]}
-				value={value?.source ?? ''}
-			/>
-			<ErrorBoundary FallbackComponent={Fallback} onError={console.error}>
-				<Suspense fallback={<p><Spinner/> Loading Binding Options</p>}>
-					<SourceSubconfig value={value} currentPost={currentPost} binding={binding} />
-				</Suspense>
-			</ErrorBoundary>
-		</fieldset>
-	});
-	const SourceSubconfig = memo(({currentPost, value, binding}: Omit<BlockBindingToolProps, 'label'>) => {
-		type SuspenseResult = {selectableOptions: NonNullable<Parameters<typeof SelectControl>[0]['options']>, params: CBBParams};
-		const {selectableOptions, params: {dbSources/*, supportsContext*/}} = useSuspenseSelect((select): SuspenseResult => {
-			if (value?.source) {
-				const sourceQueryArgs = {current_post: currentPost, source: value.source};
-				const sourceOptions = select(endpointsStore).get("plaudit-base.custom-bindings.source.options", sourceQueryArgs) as GetSelectableOptionsResponse;
-				return {
-					selectableOptions: sourceOptions.map(option => {
-						return typeof option.disabled === 'string'
-							? {...option, label: `${option.label} (${option.disabled})`, disabled: true}
-							: {...option, disabled: !!option.disabled};
-					}),
-					params: select(apiExtensionsStore).customBlockBindingsSource(value.source) ?? {}
-				};
-			} else {
-				return {selectableOptions: [], params: {}};
-			}
-		}, [currentPost, value?.source]);
-		const {updateBlockBindings} = useBlockBindingsUtils();
-
-		const subfieldKeys = useMemo<SelectableOptions[number]['subfields']>(() => {
-			if (Array.isArray(selectableOptions)) {
-				const key = value?.args['key'];
-				return key ? selectableOptions.find(option => option.value === key)?.subfields ?? [] : [];
-			}
-			return [];
-		}, [selectableOptions, value?.args['key']]);
-
-		const controls: ReactElement[] = [];
-		if (selectableOptions.length) {
-			controls.push(<SelectControl
-				key="field"
-				label="Field"
-				__next40pxDefaultSize
-				__nextHasNoMarginBottom
-				// We exclude subfield from this update because we need to reset it when the selected field changes
-				onChange={key => updateBlockBindings({[binding]: (value ? {...value, args: {key}} : undefined)})}
-				options={[
-					{
-						disabled: true,
-						label: "Select a Field",
-						value: ''
-					},
-					...selectableOptions
-				]}
-				value={value?.args['key'] ?? ''}
-			/>);
-
-			if (subfieldKeys.length) {
-				if (subfieldKeys === 'custom') {
-					controls.push(<TextControl
-						key="subfield"
-						label="Subfield"
-						__next40pxDefaultSize
-						__nextHasNoMarginBottom
-						onChange={subfield => updateBlockBindings({[binding]: (value ? {...value, args: {...value.args, subfield}} : undefined)})}
-						value={value?.args['subfield'] ?? ''}
-						help="Please enter the name of a subfield. You may need to inspect the raw data from this binding to determine the subfield."
-					/>);
-				} else {
-					controls.push(<SelectControl
-						key="subfield"
-						label="Subfield"
-						__next40pxDefaultSize
-						__nextHasNoMarginBottom
-						onChange={subfield => updateBlockBindings({[binding]: (value ? {...value, args: {...value.args, subfield}} : undefined)})}
-						options={[
-							{
-								disabled: true,
-								label: "Select a Subfield",
-								value: ''
-							},
-							...subfieldKeys
-						]}
-						value={value?.args['subfield'] ?? ''}
-					/>);
-				}
-			}
-
-			if (value?.args['key'] && dbSources?.length) {
-				controls.push(<SelectControl
-					key="db-source"
-					label="DB Source"
-					__next40pxDefaultSize
-					__nextHasNoMarginBottom
-					onChange={db_source => updateBlockBindings({[binding]: (value ? {...value, args: {...value.args, db_source}} : undefined)})}
-					options={dbSources}
-					value={value?.args['db_source'] ?? dbSources[0]!.value}
-					help={dbSources.find(dbs => dbs.value === value?.args['db_source'])?.help}
-				/>);
-			} else if (value?.args['db_source']) {
-				const {db_source, ...updatedArgs} = value.args;
-				updateBlockBindings({[binding]: {...value, args: updatedArgs}});
-			}
-		}
-		if (controls.length === 0) {
-			controls.push(<p key="no-options-found-text">No Options Found</p>);
-		}
-		return controls;
-	});
-}
-export namespace installCustomBlockBindingsSupport {
-	export let called: boolean = false;
-}
-
-function Fallback({error}: FallbackProps) {
-	const baseDisplay = <p style={{color: '#CC1818'}}>An error occurred while loading binding options</p>;
-	return typeof error === 'object' && error && 'message' in error && typeof error.message === 'string' ? <Tooltip text={error.message}>{baseDisplay}</Tooltip> : baseDisplay;
-}