@blokkli/editor 2.0.0-alpha.28 → 2.0.0-alpha.29

package/dist/global/constants/index.d.ts

@@ -0,0 +1,6 @@
+export declare const BK_HIDDEN_GLOBALLY = "bkHiddenGlobally";
+export declare const BK_VISIBLE_LANGUAGES = "bkVisibleLanguages";
+export declare const SETTINGS_GROUP: readonly ["appearance", "artboard", "behavior", "beta", "advanced"];
+export declare const VIEWPORT: readonly ["mobile", "desktop"];
+export type SettingsGroup = (typeof SETTINGS_GROUP)[number];
+export type Viewport = (typeof VIEWPORT)[number];

package/dist/global/constants/index.js

@@ -0,0 +1,10 @@
+export const BK_HIDDEN_GLOBALLY = "bkHiddenGlobally";
+export const BK_VISIBLE_LANGUAGES = "bkVisibleLanguages";
+export const SETTINGS_GROUP = [
+  "appearance",
+  "artboard",
+  "behavior",
+  "beta",
+  "advanced"
+];
+export const VIEWPORT = ["mobile", "desktop"];

package/dist/global/types/adapter.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Base type for adapter method names.
+ *
+ * In the runtime context, this is narrowed to `keyof BlokkliAdapter<any>`.
+ */
+export type AdapterMethodsBase = string;

package/dist/global/types/blockOptions.d.ts

@@ -0,0 +1,348 @@
+type DefinitionOptionText = {
+    /**
+     * The option type.
+     */
+    type: 'text';
+    /**
+     * The default value.
+     */
+    default: string;
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * The HTML input type.
+     *
+     * @default 'text'
+     */
+    inputType?: 'text' | 'number' | 'date';
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+};
+type DefinitionOptionNumber = {
+    /**
+     * The option type.
+     */
+    type: 'number';
+    /**
+     * The default value.
+     */
+    default: number;
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * Minimum allowed value.
+     */
+    min: number;
+    /**
+     * Maximum allowed value.
+     */
+    max: number;
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+};
+type DefinitionOptionRange = {
+    /**
+     * The option type.
+     */
+    type: 'range';
+    /**
+     * The default value.
+     */
+    default: number;
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * Minimum allowed value.
+     */
+    min: number;
+    /**
+     * Maximum allowed value.
+     */
+    max: number;
+    /**
+     * The step increment.
+     */
+    step: number;
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+};
+type DefinitionOptionDateTimeLocal = {
+    /**
+     * The option type.
+     */
+    type: 'datetime-local';
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * The default value as an ISO 8601 datetime string.
+     *
+     * @example '2024-03-15T14:30:00'
+     */
+    default?: string;
+    /**
+     * Minimum allowed datetime as an ISO 8601 string.
+     */
+    min?: string;
+    /**
+     * Maximum allowed datetime as an ISO 8601 string.
+     */
+    max?: string;
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+};
+type DefinitionOptionCheckbox = {
+    /**
+     * The option type.
+     */
+    type: 'checkbox';
+    /**
+     * The default value.
+     */
+    default: boolean;
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+};
+type DefinitionOptionColor = {
+    /**
+     * The option type.
+     */
+    type: 'color';
+    /**
+     * The default value as a HEX color string.
+     *
+     * @example '#ff0000'
+     */
+    default: `#${string}`;
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+};
+type DefinitionOptionCheckboxes = {
+    /**
+     * The option type.
+     */
+    type: 'checkboxes';
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * The default values.
+     */
+    default: string[];
+    /**
+     * Available options.
+     *
+     * Key is the option value, value is the display label.
+     */
+    options: Record<string, string>;
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+};
+type DefinitionOptionRadiosGridOption = {
+    /**
+     * Column widths as flex-grow values.
+     *
+     * @example [1, 2] for a 1:2 ratio
+     */
+    columns: number[];
+    /**
+     * The label displayed for this option.
+     */
+    label: string;
+};
+type DefinitionOptionRadiosGrid = {
+    /**
+     * Display options as grid layouts.
+     */
+    displayAs: 'grid';
+    /**
+     * Available options.
+     *
+     * Key is the option value, value is the grid configuration.
+     */
+    options: Record<string, DefinitionOptionRadiosGridOption>;
+};
+type DefinitionOptionRadiosColorsOption = {
+    /**
+     * Optional HEX color value.
+     *
+     * @example '#ff0000'
+     */
+    hex?: `#${string}`;
+    /**
+     * Optional CSS class for the color.
+     *
+     * Used as fallback when hex is not provided.
+     */
+    class?: string;
+    /**
+     * The label displayed for this option.
+     */
+    label: string;
+};
+type DefinitionOptionRadiosColors = {
+    /**
+     * Display options as color swatches.
+     */
+    displayAs: 'colors';
+    /**
+     * Available color options.
+     *
+     * Key is the option value, value is the color configuration.
+     */
+    options: Record<string, DefinitionOptionRadiosColorsOption>;
+};
+type DefinitionOptionRadiosRadios = {
+    /**
+     * Display options as radio buttons.
+     *
+     * @default 'radios'
+     */
+    displayAs?: 'radios' | undefined;
+    /**
+     * Available options.
+     *
+     * Key is the option value, value is the display label.
+     */
+    options: Record<string, string>;
+};
+type DefinitionOptionRadiosIconsOptionBase<Icon extends string = string> = {
+    /**
+     * The icon to display.
+     *
+     * Icon files must be in the same folder as the component and start with 'icon-blokkli-'.
+     */
+    icon: Icon;
+    /**
+     * The label displayed for this option.
+     */
+    label: string;
+};
+type DefinitionOptionRadiosIconsBase<Icon extends string = string> = {
+    /**
+     * Display options as icons.
+     */
+    displayAs: 'icons';
+    /**
+     * Available icon options.
+     *
+     * Key is the option value, value is the icon configuration.
+     */
+    options: Record<string, DefinitionOptionRadiosIconsOptionBase<Icon>>;
+};
+type DefinitionOptionRadiosBase<Icon extends string = string> = {
+    /**
+     * The option type.
+     */
+    type: 'radios';
+    /**
+     * The label displayed in the editor.
+     */
+    label: string;
+    /**
+     * Optional description providing additional context.
+     *
+     * Displayed below the option label in the editor.
+     */
+    description?: string;
+    /**
+     * The default value.
+     *
+     * Must be one of the option keys.
+     */
+    default: string;
+    /**
+     * Optional group name for organizing options.
+     *
+     * Options with the same group are displayed together in a dropdown.
+     */
+    group?: string;
+} & (DefinitionOptionRadiosColors | DefinitionOptionRadiosGrid | DefinitionOptionRadiosRadios | DefinitionOptionRadiosIconsBase<Icon>);
+export type BlockOptionDefinitionBase<Icon extends string = string> = DefinitionOptionColor | DefinitionOptionCheckbox | DefinitionOptionCheckboxes | DefinitionOptionRadiosBase<Icon> | DefinitionOptionText | DefinitionOptionRange | DefinitionOptionNumber | DefinitionOptionDateTimeLocal;
+export {};

package/dist/global/types/definitions.d.ts

@@ -0,0 +1,278 @@
+import type { BlockOptionDefinitionBase } from './blockOptions';
+export type BlockDefinitionOptionsInputBase = {
+    [key: string]: BlockOptionDefinitionBase;
+};
+export type BlokkliDefinitionAddBehaviour = 'no-form' | 'form' | `editable:${string}`;
+export type BlockDefinitionRenderForParentBase<BundleWithNested extends string = string> = {
+    parentBundle: BundleWithNested;
+};
+export type BlockDefinitionRenderForFieldListBase<FieldListTypes extends string = string> = {
+    /**
+     * @deprecated Use `fieldListType` instead.
+     */
+    fieldList: FieldListTypes;
+};
+export type BlockDefinitionRenderForFieldListTypeBase<FieldListTypes extends string = string> = {
+    fieldListType: FieldListTypes;
+};
+export type BlockDefinitionRenderForBase<BundleWithNested extends string = string, FieldListTypes extends string = string> = BlockDefinitionRenderForParentBase<BundleWithNested> | BlockDefinitionRenderForFieldListBase<FieldListTypes> | BlockDefinitionRenderForFieldListTypeBase<FieldListTypes>;
+export type BlokkliDefinitionInputEditorBase<Options extends BlockDefinitionOptionsInputBase = BlockDefinitionOptionsInputBase, Icon extends string = string, PropsType = Record<string, any>> = {
+    /**
+     * The icon rendered in the editor.
+     */
+    icon?: Icon;
+    /**
+     * Determine which options should be visible in the editor based on the
+     * given context.
+     *
+     * If a method is defined, it is called whenever any of the options change.
+     */
+    determineVisibleOptions?: (ctx: any) => Array<keyof Options | string>;
+    /**
+     * Disable editing for blocks that don't have any editable fields.
+     *
+     * This disables the "Edit" button in the actions overlay and double click
+     * to edit.
+     */
+    disableEdit?: boolean;
+    /**
+     * If set, if this block is being rendered standalone (e.g. when inside the
+     * "add to library" dialog), the given will be used as the root width. The
+     * rendered block is then scaled down so that it fits the available space.
+     */
+    previewWidth?: number;
+    /**
+     * When set to true the preview in the library is not rendered.
+     *
+     * This should be used for complex components that render things like sliders,
+     * iframes, modals, etc.
+     */
+    noPreview?: boolean;
+    /**
+     * A background color class that is applied during editing when the component
+     * is being displayed standalone in a preview.
+     *
+     * For example, when the block can be made reusable and is being disabled in
+     * the "Add from Library" dialog, the given background class is used on the
+     * parent element.
+     *
+     * This can be used for blocks that render white text and are always
+     * rendered on top of a black background. Defining a background class makes
+     * sure the text is visible for the user.
+     */
+    previewBackgroundClass?: string;
+    /**
+     * Define the behaviour when a new block is added of this type.
+     *
+     * Possible options:
+     * - 'form' (default)
+     *    Shows the full form to enter block values.
+     * - 'no-form'
+     *    Immediately adds the block without showing the full form.
+     * - 'editable:${string}'
+     *    Immediately add the block without showing the full form and
+     *    immediately open the editable field form with the given name.
+     *    For example, when the block has an editable field named "body"
+     *    a possible value would be 'editable:body'.
+     */
+    addBehaviour?: BlokkliDefinitionAddBehaviour;
+    /**
+     * Define a custom title for this block at runtime in the editor.
+     *
+     * The title will be displayed to the editor to give some context. E.g. a
+     * title block displays an excerpt from the title.
+     *
+     * If a method is provided, it receives the root element of this component
+     * and should return a fitting title.
+     *
+     * If no method is defined or it doesn't return a value, the regular label
+     * of the bundle (e.g. "Teaser") is displayed.
+     */
+    editTitle?: (el: HTMLElement) => string | undefined | null;
+    /**
+     * Build mock props for this component that are used when this block can
+     * be added from clipboard or search text content.
+     *
+     * The props are then used to render a preview of the block.
+     *
+     * For example, when pasting text into the editor and if supported by the
+     * adapter, the clipboard text content is passed as an argument.
+     */
+    mockProps?: (text?: string) => Record<string, any>;
+    /**
+     * Hides the block from the add list if more than the given amount of
+     * blocks aready exist on the page.
+     *
+     * Note this only affects the behaviour in the editor, it's still possible
+     * to have more blocks on the page, just not via the editor.
+     */
+    maxInstances?: number;
+    /**
+     * Get the drag element for the editor.
+     *
+     * @deprecated Use a ref in the template to designate the draggable element (e.g. <div ref="blokkliDraggable">).
+     */
+    getDraggableElement?: (el: HTMLElement) => Element | undefined | null;
+    /**
+     * Define how the nested fields should be structured when the block is
+     * rendered without its component, for example when using
+     * `:proxy-mode="true"` on <BlokkliField>.
+     *
+     * Each array should define an array of field names.
+     *
+     * @example
+     * ```typescript
+     * defineBlokkli({
+     *   bundle: 'three_columns',
+     *   editor: {
+     *     fieldLayout: [
+     *       ['header'],
+     *       ['left', 'center', 'right'],
+     *     ]
+     *   }
+     * })
+     * ```
+     */
+    fieldLayout?: string[][];
+    /**
+     * Define how this component's props should be rendered in the diff view.
+     *
+     * By default, the diff feature assumes all props to be text and will render
+     * plaintext props as HTML and convert complex props (such as arrays or objects)
+     * to string using JSON.stringify().
+     *
+     * You can instead return a string representation of each prop that is used
+     * to display the prop instead.
+     *
+     * For example, if the prop is an image, you may return the filename of the
+     * image instead. If the prop is a number, you can return the formatted number.
+     *
+     * You can also return HTML as the value. The feature uses an HTML differ to
+     * render the diff.
+     */
+    mapDiffProps?: (props?: PropsType) => Record<string, string>;
+};
+export type BlockDefinitionInputBase<Options extends BlockDefinitionOptionsInputBase = BlockDefinitionOptionsInputBase, GlobalOptions extends string[] | undefined = string[], Bundle extends string = string, ChunkNames extends string = string, BundleWithNested extends string = string, FieldListTypes extends string = string, Icon extends string = string, BundlePropsMap extends Record<string, Record<string, any>> = Record<string, Record<string, any>>> = {
+    /**
+     * The bundle ID of the block, e.g. "text" or "section_title".
+     */
+    bundle: Bundle;
+    /**
+     * Define the name of a block bundle that supports nested blocks.
+     * If a bundle is defined, then this component will be rendered if the
+     * parent matches the given bundle.
+     */
+    renderFor?: BlockDefinitionRenderForBase<BundleWithNested, FieldListTypes> | BlockDefinitionRenderForBase<BundleWithNested, FieldListTypes>[];
+    /**
+     * The name of the chunk group.
+     *
+     * If this value is set, the component will be assigned to this
+     * import chunk. Multiple components can have the same chunk name.
+     *
+     * See the `chunkNames` option on the module's configuration for more details.
+     */
+    chunkName?: ChunkNames;
+    /**
+     * Define options available for this block.
+     */
+    options?: Options;
+    /**
+     * Global options to use.
+     *
+     * These options will be merged with the component-specific options.
+     */
+    globalOptions?: GlobalOptions;
+    /**
+     * Settings for the behaviour in the editor.
+     */
+    editor?: BlokkliDefinitionInputEditorBase<Options, Icon, Bundle extends keyof BundlePropsMap ? BundlePropsMap[Bundle] : Record<string, any>>;
+    /**
+     * Map which component prop maps to which field name.
+     *
+     * For example, if the field is named "field_paragraphs_header" and the prop
+     * is named "headerParagraphs", you would define it as such:
+     *
+     * @example
+     * ```vue
+     * <template>
+     *   <div>
+     *     <BlokkliField :list="headerParagraphs" name="field_paragraphs_header" />
+     *   </div>
+     * <template>
+     *
+     * <script lang="ts" setup>
+     * import type { ParagraphTwoColumnsFragment } from '#graphql-operations'
+     *
+     * defineProps<{
+     *   headerParagraphs: ParagraphTwoColumnsFragment['headerParagraphs']
+     * }>()
+     *
+     * defineBlokkli({
+     *   bundle: 'section',
+     *   propsFieldMapping: {
+     *     headerParagraphs: 'field_paragraphs_header',
+     *   }
+     * })
+     * </script>
+     * ```
+     */
+    propsFieldMapping?: Bundle extends keyof BundlePropsMap ? Partial<Record<keyof BundlePropsMap[Bundle], string>> : never;
+};
+export type FragmentDefinitionInputBase<Options extends BlockDefinitionOptionsInputBase = BlockDefinitionOptionsInputBase, GlobalOptions extends string[] | undefined = string[], ChunkNames extends string = string, Icon extends string = string> = {
+    /**
+     * The unique name of this fragment.
+     */
+    name: string;
+    /**
+     * The label of the fragment.
+     */
+    label: string;
+    /**
+     * A short description.
+     */
+    description?: string;
+    /**
+     * The name of the chunk group.
+     *
+     * If this value is set, the component will be assigned to this
+     * import chunk. Multiple components can have the same chunk name.
+     *
+     * See the `chunkNames` option on the module's configuration for more details.
+     */
+    chunkName?: ChunkNames;
+    /**
+     * Define options available for this block.
+     */
+    options?: Options;
+    /**
+     * Global options to use.
+     *
+     * These options will be merged with the component-specific options.
+     */
+    globalOptions?: GlobalOptions;
+    /**
+     * Settings for the behaviour in the editor.
+     */
+    editor?: BlokkliDefinitionInputEditorBase<Options, Icon>;
+};
+export type ProviderDefinitionInputBase<Options extends BlockDefinitionOptionsInputBase = BlockDefinitionOptionsInputBase, GlobalOptions extends string[] | undefined = string[]> = {
+    /**
+     * The entity type.
+     */
+    entityType: string;
+    /**
+     * The bundle.
+     */
+    bundle: string;
+    /**
+     * Define options available for this block.
+     */
+    options?: Options;
+    /**
+     * Global options to use.
+     *
+     * These options will be merged with the component-specific options.
+     */
+    globalOptions?: GlobalOptions;
+    propsFieldMapping?: Record<string, string>;
+};