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

package/dist/runtime/adapter/index.d.ts

@@ -1,516 +0,0 @@
-import type { ComputedRef } from 'vue';
-import type { CommentItem, ConversionItem, MappedState, ImportItem, LibraryItem, BlockBundleDefinition, EntityTranslation, SearchContentItem, AddClipboardItemEvent, AddNewBlockEvent, AddReusableItemEvent, ImportFromExistingEvent, MakeReusableEvent, MoveMultipleBlocksEvent, MoveBlockEvent, UpdateBlockOptionEvent, AddContentSearchItemEvent, TransformPlugin, EditBlockEvent, PasteExistingBlocksEvent, UpdateFieldValueEvent, AssistantResult, DraggableHostData, DetachReusableBlockEvent, FieldConfig, EditableFieldConfig, DraggableMediaLibraryItem, DroppableFieldConfig, PublishOptions, GetEditStatesItem, UpdateHostOptionEvent, HostTransformPlugin, PluginConfigInputItem } from './../types/index.js';
-import type getVideoId from 'get-video-id';
-import type { GetMediaLibraryFunction } from './../components/Edit/Features/MediaLibrary/types.js';
-import type { Analyzer } from '#blokkli/analyzer/types';
-export type { GetMediaLibraryFunction };
-export interface MutationResponseLike<T> {
-    success: boolean;
-    state: T;
-    errors?: string[];
-}
-type AdapterApplyTransformPlugin = {
-    pluginId: string;
-    uuids: string[];
-    config?: PluginConfigInputItem[];
-};
-type AdapterApplyHostTransformPlugin = {
-    pluginId: string;
-    config?: PluginConfigInputItem[];
-};
-export type UpdateEntityFieldValueEvent = {
-    fieldName: string;
-    fieldValue: string;
-};
-export type AdapterFragmentsAddBlock = {
-    name: string;
-    host: DraggableHostData;
-    preceedingUuid?: string;
-};
-export type MediaLibraryAddBlockEvent = {
-    host: DraggableHostData;
-    preceedingUuid?: string;
-    item: DraggableMediaLibraryItem;
-};
-export type MediaLibraryAddBlocksEvent = {
-    host: DraggableHostData;
-    preceedingUuid?: string;
-    items: DraggableMediaLibraryItem[];
-};
-export type MediaLibraryReplaceMediaEvent = {
-    /**
-     * The UUID of the block on which the media was dropped.
-     */
-    host: DraggableHostData;
-    /**
-     * The ID of the media that was dropped.
-     */
-    mediaId: string;
-};
-type AdapterAssistantAddBlockFromResult = {
-    result: AssistantResult;
-    host: DraggableHostData;
-    preceedingUuid?: string;
-};
-type AdapterAssistantGetResultsCreate = {
-    type: 'create';
-    prompt: string;
-};
-type AdapterAssistantGetResultsEdit = {
-    type: 'edit';
-    /**
-     * The text that should be edited.
-     */
-    text: string;
-    prompt: string;
-};
-type AdapterAssistantGetResults = AdapterAssistantGetResultsCreate | AdapterAssistantGetResultsEdit;
-type AdapterBuildEditableFrameUrl = {
-    fieldName: string;
-    uuid?: string;
-};
-type AdapterFormFrameBuilderResult = {
-    url: string;
-};
-type AdapterFormFrameBuilderBlockAdd = {
-    id: 'block:add';
-    data: AddNewBlockEvent;
-};
-type AdapterFormFrameBuilderBlockTranslate = {
-    id: 'block:translate';
-    data: EditBlockEvent;
-    langcode: string;
-};
-type AdapterFormFrameBuilderBlockEdit = {
-    id: 'block:edit';
-    data: EditBlockEvent;
-};
-type AdapterFormFrameBuilderEntityEdit = {
-    id: 'entity:edit';
-};
-type AdapterFormFrameBuilderEntityTranslate = {
-    id: 'entity:translate';
-    translation: EntityTranslation;
-};
-type AdapterFormFrameBuilderBatchTranslate = {
-    id: 'batchTranslate';
-};
-export type AdapterFormFrameBuilder = AdapterFormFrameBuilderBlockAdd | AdapterFormFrameBuilderBlockEdit | AdapterFormFrameBuilderBlockTranslate | AdapterFormFrameBuilderEntityEdit | AdapterFormFrameBuilderEntityTranslate | AdapterFormFrameBuilderBatchTranslate;
-export interface AdapterContext {
-    entityType: string;
-    entityUuid: string;
-    entityBundle: string;
-    language: string;
-}
-export type ClipboardMapBundleEventPlaintext = {
-    type: 'plaintext';
-    text: string;
-};
-export type ClipboardMapBundleEventImage = {
-    type: 'image';
-    fileType: string;
-    fileSize: number;
-};
-export type ClipboardMapBundleEventFile = {
-    type: 'file';
-    fileType: string;
-    fileSize: number;
-};
-export type ClipboardMapBundleEventVideo = {
-    type: 'video';
-    videoService: ReturnType<typeof getVideoId>['service'];
-    videoId: string;
-};
-export type ClipboardMapBundleEvent = ClipboardMapBundleEventVideo | ClipboardMapBundleEventImage | ClipboardMapBundleEventFile | ClipboardMapBundleEventPlaintext;
-export type BlokkliAdapterGetLibraryItemsData = {
-    bundles: string[];
-    page: number;
-    text: string;
-};
-export type BlokkliAdapterSearchResults<T> = {
-    items: T[];
-    total: number;
-    perPage: number;
-};
-export type BlokkliAdapterGetLibraryItemsResult = BlokkliAdapterSearchResults<LibraryItem>;
-export type BlokkliAdapterGetEditStatesResult = BlokkliAdapterSearchResults<GetEditStatesItem>;
-export type BlokkliAdapterPublishOptions = {
-    /**
-     * The host entity type.
-     */
-    hostEntityType: string;
-    /**
-     * The host entity UUID.
-     */
-    hostEntityUuid: string;
-    /**
-     * Whether the editor will be closed after publishing.
-     *
-     * If false, the adapter should return an empty state again, so that the
-     * editor UI shows the correct state (no pending changes).
-     * If true, the adapter may return no state at all, since the editor will
-     * be closed anyway after publishing.
-     */
-    closeAfterPublish?: boolean;
-    /**
-     * If the host entity is currently unpublished, publish it.
-     */
-    publishIfUnpublished?: boolean;
-    /**
-     * The revision log message.
-     */
-    revisionLogMessage?: string;
-};
-export type BlokkliAdapterScheduleOptions = {
-    /**
-     * The host entity type.
-     */
-    hostEntityType: string;
-    /**
-     * The host entity UUID.
-     */
-    hostEntityUuid: string;
-    /**
-     * The revision log message.
-     */
-    revisionLogMessage?: string;
-    /**
-     * The date and time when the edit state should be published.
-     */
-    date: string;
-};
-export type BlokkliAdapterSetBlockScheduleOptions = {
-    /**
-     * The UUID of the block.
-     */
-    uuid: string;
-    /**
-     * The schedule type.
-     */
-    type: 'publish' | 'unpublish';
-    /**
-     * The date. If empty, remove the schedule date.
-     */
-    date?: string;
-};
-export type BlokkliAdapterUnscheduleBlockOptions = {
-    uuid: string;
-};
-export type BlokkliAdapterUnscheduleOptions = {
-    /**
-     * The host entity type.
-     */
-    hostEntityType: string;
-    /**
-     * The host entity UUID.
-     */
-    hostEntityUuid: string;
-};
-export interface BlokkliAdapter<T> {
-    /**
-     * Load the state.
-     */
-    loadState(): Promise<T | undefined>;
-    /**
-     * Load the unchanged state.
-     */
-    loadStateAtIndex?: (index: number) => Promise<T | undefined>;
-    mapState(state: T): MappedState;
-    /**
-     * Get disabled features at runtime.
-     *
-     * For example, the "Translation" feature can be disabled if the current
-     * entity does not support translations.
-     *
-     * For features that are always disabled, use the `alterFeatures` option of
-     * the module to remove them entirely.
-     */
-    getDisabledFeatures?: () => Promise<string[]>;
-    /**
-     * Return a list of all types.
-     */
-    getAllBundles(): Promise<BlockBundleDefinition[]>;
-    /**
-     * Get the field configurations.
-     */
-    getFieldConfig(): Promise<FieldConfig[]>;
-    /**
-     * Get the editable field configurations.
-     */
-    getEditableFieldConfig?: () => Promise<EditableFieldConfig[]>;
-    /**
-     * Get the droppable field configurations.
-     */
-    getDroppableFieldConfig?: () => Promise<DroppableFieldConfig[]>;
-    /**
-     * Get all possible conversions.
-     */
-    getConversions?: () => Promise<ConversionItem[]>;
-    /**
-     * Convert multiple items.
-     */
-    convertBlocks?: (uuids: string[], targetBundle: string) => Promise<MutationResponseLike<T>>;
-    /**
-     * Get all possible transform plugins.
-     */
-    getTransformPlugins?: () => Promise<TransformPlugin[]>;
-    /**
-     * Get all possible host transform plugins.
-     */
-    getHostTransformPlugins?: () => Promise<HostTransformPlugin[]>;
-    /**
-     * Apply a transform plugin.
-     */
-    applyTransformPlugin?: (e: AdapterApplyTransformPlugin) => Promise<MutationResponseLike<T>>;
-    /**
-     * Preview the output of a transform plugin.
-     *
-     * The transform plugin is expected to apply its transform without actually
-     * persisting it and not creating any side effects.
-     *
-     * It must produce the same result when called for the "final"
-     * transformation that is added to the edit state.
-     */
-    previewTransformPlugin?: (e: AdapterApplyTransformPlugin) => Promise<MutationResponseLike<T>>;
-    /**
-     * Apply a host transform plugin.
-     */
-    applyHostTransformPlugin?: (e: AdapterApplyHostTransformPlugin) => Promise<MutationResponseLike<T>>;
-    /**
-     * Preview the output of a host transform plugin.
-     *
-     * The transform plugin is expected to apply its transform without actually
-     * persisting it and not creating any side effects.
-     *
-     * It must produce the same result when called for the "final"
-     * transformation that is added to the edit state.
-     */
-    previewHostTransformPlugin?: (e: AdapterApplyHostTransformPlugin) => Promise<MutationResponseLike<T>>;
-    /**
-     * Add a new block.
-     */
-    addNewBlock(e: AddNewBlockEvent): Promise<MutationResponseLike<T>>;
-    /**
-     * Update multiple options.
-     */
-    updateOptions?: (options: UpdateBlockOptionEvent[]) => Promise<MutationResponseLike<T>>;
-    /**
-     * Update multiple host options.
-     */
-    updateHostOptions?: (options: UpdateHostOptionEvent[]) => Promise<MutationResponseLike<T>>;
-    /**
-     * Determine the block bundle for the given clipboard item.
-     */
-    clipboardMapBundle?: (e: ClipboardMapBundleEvent) => string | undefined | null;
-    /**
-     * Add a clipboard item.
-     */
-    addBlockFromClipboardItem?: (e: AddClipboardItemEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Move an item.
-     */
-    moveBlock(e: MoveBlockEvent): Promise<MutationResponseLike<T>>;
-    /**
-     * Move multiple items.
-     */
-    moveMultipleBlocks(e: MoveMultipleBlocksEvent): Promise<MutationResponseLike<T>>;
-    /**
-     * Add a reusable item.
-     */
-    addLibraryItem?: (e: AddReusableItemEvent) => Promise<MutationResponseLike<T>>;
-    /**
-     * Build the URL to edit a library item.
-     */
-    getLibraryItemEditUrl?: (uuid: string) => string;
-    /**
-     * Delete multiple items.
-     */
-    deleteBlocks?: (uuids: string[]) => Promise<MutationResponseLike<T>>;
-    /**
-     * Duplicate blocks.
-     */
-    duplicateBlocks?: (uuids: string[]) => Promise<MutationResponseLike<T>>;
-    /**
-     * Paste existing blocks.
-     */
-    pasteExistingBlocks?: (e: PasteExistingBlocksEvent) => Promise<MutationResponseLike<T>>;
-    /**
-     * Get all existing entities for importing.
-     */
-    getImportItems?: (searchText?: string) => Promise<{
-        items: ImportItem[];
-        total: number;
-    }>;
-    /**
-     * Import items from an existing entity.
-     */
-    importFromExisting?: (e: ImportFromExistingEvent) => Promise<MutationResponseLike<T>>;
-    /**
-     * Revert all changes to the last published state.
-     */
-    revertAllChanges?: () => Promise<MutationResponseLike<T>>;
-    /**
-     * Publish all changes.
-     */
-    publish?: (options: BlokkliAdapterPublishOptions) => Promise<MutationResponseLike<T | undefined | null>>;
-    /**
-     * Schedule an edit state.
-     */
-    scheduleEditState?: (options: BlokkliAdapterScheduleOptions) => Promise<MutationResponseLike<T | undefined | null>>;
-    /**
-     * Unschedule an already scheduled edit state.
-     */
-    unscheduleEditState?: (options: BlokkliAdapterUnscheduleOptions) => Promise<MutationResponseLike<T | undefined | null>>;
-    /**
-     * Schedule a block.
-     */
-    setBlockScheduleDate?: (blocks: BlokkliAdapterSetBlockScheduleOptions[]) => Promise<MutationResponseLike<T | undefined | null>>;
-    /**
-     * Set a specific history index.
-     */
-    setHistoryIndex?: (index: number) => Promise<MutationResponseLike<T>>;
-    /**
-     * Set the status of a mutation item.
-     */
-    setMutationItemStatus?: (index: number, status: boolean) => Promise<MutationResponseLike<T>>;
-    /**
-     * Take ownership of the edit state.
-     */
-    takeOwnership?: () => Promise<MutationResponseLike<T>>;
-    /**
-     * Load all comments.
-     */
-    loadComments?: () => Promise<CommentItem[]>;
-    /**
-     * Add a comment to one or more items.
-     */
-    addComment?: (blockUuids: string[], body: string) => Promise<CommentItem[]>;
-    /**
-     * Resolve a comment.
-     */
-    resolveComment?: (uuid: string) => Promise<CommentItem[]>;
-    /**
-     * Get the publish options.
-     */
-    getPublishOptions?: () => Promise<PublishOptions>;
-    /**
-     * Search for edit states.
-     */
-    getEditStates?: (page?: number) => Promise<BlokkliAdapterGetEditStatesResult>;
-    /**
-     * Make an item reusable.
-     */
-    makeBlockReusable?: (e: MakeReusableEvent) => Promise<MutationResponseLike<T>>;
-    /**
-     * Detach a reusable block and add a copy of it in place.
-     */
-    detachReusableBlock?: (e: DetachReusableBlockEvent) => Promise<MutationResponseLike<T>>;
-    /**
-     * Get all library items.
-     */
-    getLibraryItems?: (data: BlokkliAdapterGetLibraryItemsData) => Promise<BlokkliAdapterGetLibraryItemsResult>;
-    /**
-     * Get the last changed timestamp for the edit state.
-     */
-    getLastChanged?: () => Promise<number>;
-    /**
-     * Get the shareable preview URL.
-     *
-     * This should return a URL that can be used to bypass logins, using a token or similar, that can be shared with non-editing people.
-     */
-    getPreviewGrantUrl?: () => Promise<string | undefined | null> | string | undefined | null;
-    /**
-     * Return the possible content search tabs.
-     */
-    getContentSearchTabs?: () => Record<string, string> | Promise<Record<string, string>>;
-    /**
-     * Return items for the "content" search.
-     *
-     * Should only return a limited amount of results, sorted by relevance.
-     */
-    getContentSearchResults?: (tab: string, text: string) => Promise<SearchContentItem[]>;
-    /**
-     * Add the dropped item from a search content item.
-     */
-    addContentSearchItem?: (e: AddContentSearchItemEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Change the language.
-     */
-    changeLanguage?: (translation: EntityTranslation) => Promise<any>;
-    /**
-     * Build the URL for forms.
-     */
-    formFrameBuilder?: (e: AdapterFormFrameBuilder) => AdapterFormFrameBuilderResult | undefined;
-    /**
-     * Update the value of a single block field.
-     */
-    updateFieldValue?: (e: UpdateFieldValueEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Update the value of a single entity field.
-     */
-    updateEntityFieldValue?: (e: UpdateEntityFieldValueEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Build the iframe URL for an editable of type "frame".
-     */
-    buildEditableFrameUrl?: (e: AdapterBuildEditableFrameUrl) => string | undefined;
-    /**
-     * Get the result for an assistant query.
-     */
-    assistantGetResults?: (e: AdapterAssistantGetResults) => Promise<AssistantResult | undefined>;
-    /**
-     * Add one or more blocks from the given assistant result.
-     */
-    assistantAddBlockFromResult?: (e: AdapterAssistantAddBlockFromResult) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Return the HTML markup for displaying the grid.
-     */
-    getGridMarkup?: () => Promise<string> | string;
-    /**
-     * Return the media library results and filters using the given selected filter.
-     */
-    mediaLibraryGetResults?: GetMediaLibraryFunction<any>;
-    /**
-     * Create a new block from the given media library item.
-     */
-    mediaLibraryAddBlock?: (e: MediaLibraryAddBlockEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Create new blocks from the given media library items.
-     */
-    mediaLibraryAddBlocks?: (e: MediaLibraryAddBlocksEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Replace an existing media from a block with a new one.
-     *
-     * This method is called when the user drag and drops an item from the media
-     * library onto an v-blokkli-droppable element.
-     */
-    mediaLibraryReplaceMedia?: (e: MediaLibraryReplaceMediaEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Replace an existing media on a field of the page entity.
-     *
-     * This method is called when the user drag and drops an item from the media
-     * library onto an v-blokkli-droppable element where the host is the page entity..
-     */
-    mediaLibraryReplaceEntityMedia?: (e: MediaLibraryReplaceMediaEvent) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Add a fragment block.
-     */
-    fragmentsAddBlock?: (e: AdapterFragmentsAddBlock) => Promise<MutationResponseLike<T>> | undefined;
-    /**
-     * Build the link that is copied to the clipboard when clicking on an "anchor link" indicator.
-     */
-    buildAnchorLink?: (id: string, uuid: string) => string;
-    getAnalyzers?: () => Analyzer | Analyzer[] | Promise<Analyzer> | Promise<Analyzer[]>;
-    userSettings?: {
-        /**
-         * Load user settings.
-         */
-        load: () => Promise<string | Record<string, any>>;
-        /**
-         * Persist user settings.
-         */
-        persist: (settings: string) => Promise<undefined>;
-    };
-}
-export type BlokkliAdapterFactory<T> = (ctx: ComputedRef<AdapterContext>) => Promise<BlokkliAdapter<T>> | BlokkliAdapter<T>;
-export type AdapterMethods = keyof BlokkliAdapter<any>;
-export declare function defineBlokkliEditAdapter<T>(cb: BlokkliAdapterFactory<T>): BlokkliAdapterFactory<T>;

package/dist/runtime/blokkliPlugins/BlockIndicator/index.vue

@@ -1,65 +0,0 @@
-<template>
-  <Teleport to="#bk-indicators-left">
-    <div
-      ref="el"
-      class="bk-indicator-item"
-      @click.prevent="$emit('click')"
-      @mouseenter="onMouseEnter"
-      @mouseleave="onMouseLeave"
-    >
-      <slot>
-        <div class="bk-indicator-item-inner">
-          <div v-if="label">{{ label }}</div>
-          <div v-if="icon">
-            <Icon :name="icon" />
-          </div>
-        </div>
-      </slot>
-    </div>
-  </Teleport>
-</template>
-
-<script setup>
-import {
-  useBlokkli,
-  onMounted,
-  useTemplateRef,
-  onBeforeUnmount
-} from "#imports";
-import { Icon } from "#blokkli/components";
-const props = defineProps({
-  id: { type: String, required: true },
-  uuid: { type: String, required: true },
-  label: { type: String, required: false },
-  position: { type: String, required: false },
-  icon: { type: null, required: false }
-});
-defineEmits(["click"]);
-const { indicators } = useBlokkli();
-const el = useTemplateRef("el");
-function onMouseEnter() {
-  indicators.setHovered(props.uuid);
-}
-function onMouseLeave() {
-  indicators.setHovered();
-}
-onMounted(() => {
-  if (el.value) {
-    indicators.addIndicator({
-      id: props.id,
-      uuid: props.uuid,
-      position: props.position ?? "left",
-      element: el.value
-    });
-  }
-});
-onBeforeUnmount(() => {
-  indicators.removeIndicator(props.id, props.uuid);
-});
-</script>
-
-<script>
-export default {
-  name: "PluginBlockIndicator"
-};
-</script>

package/dist/runtime/blokkliPlugins/BlockIndicator/index.vue.d.ts

@@ -1,64 +0,0 @@
-import type { BlokkliIcon } from '#blokkli-build/icons';
-declare const _default: __VLS_WithSlots<import("vue").DefineComponent<{
-    /**
-     * Unique identifier for this indicator.
-     *
-     * Should be unique per block instance.
-     */
-    id: string;
-    /**
-     * The UUID of the block this indicator is attached to.
-     */
-    uuid: string;
-    /**
-     * Optional text label to display in the indicator.
-     */
-    label?: string;
-    /**
-     * Which side of the block to display the indicator.
-     *
-     * @default 'left'
-     */
-    position?: "left" | "right";
-    /**
-     * Optional icon to display in the indicator.
-     */
-    icon?: BlokkliIcon;
-}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
-    click: () => any;
-}, string, import("vue").PublicProps, Readonly<{
-    /**
-     * Unique identifier for this indicator.
-     *
-     * Should be unique per block instance.
-     */
-    id: string;
-    /**
-     * The UUID of the block this indicator is attached to.
-     */
-    uuid: string;
-    /**
-     * Optional text label to display in the indicator.
-     */
-    label?: string;
-    /**
-     * Which side of the block to display the indicator.
-     *
-     * @default 'left'
-     */
-    position?: "left" | "right";
-    /**
-     * Optional icon to display in the indicator.
-     */
-    icon?: BlokkliIcon;
-}> & Readonly<{
-    onClick?: (() => any) | undefined;
-}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, {
-    default?: (props: {}) => any;
-}>;
-export default _default;
-type __VLS_WithSlots<T, S> = T & {
-    new (): {
-        $slots: S;
-    };
-};