@blokkli/editor 2.0.0-alpha.4 → 2.0.0-alpha.41

package/dist/runtime/editor/components/DraggableList.vue

@@ -0,0 +1,148 @@
+<template>
+  <div
+    v-if="proxyMode || globalProxyMode"
+    class="bk bk-field-list-proxy"
+    :class="[
+  {
+    'bk-is-visible': proxyVisible
+  },
+  'bk-is-' + (dropAlignment || (nestingLevel === 0 ? 'vertical' : 'horizontal'))
+]"
+  >
+    <div
+      ref="root"
+      class="bk-field-list-proxy-list bk-draggable-list-container"
+      :class="{
+  'bk-is-compact': list.length > 8
+}"
+    >
+      <BlokkliItem
+        v-for="(item, i) in list"
+        :key="item.uuid + fieldListType"
+        class="bk-field-list-item"
+        :uuid="item.uuid"
+        :bundle="item.bundle"
+        :options="item.options"
+        :props="item.props"
+        is-editing
+        :index="i"
+        :data-bk-uuid="item.uuid"
+        :parent-type="isNested ? entity.bundle : ''"
+        :data-bk-is-muted="isMuted(item)"
+      />
+    </div>
+  </div>
+  <Component
+    :is="tag"
+    v-else
+    ref="root"
+    :class="['bk-draggable-list-container', attrs.class]"
+  >
+    <BlokkliItem
+      v-for="(item, i) in list"
+      :key="item.uuid + fieldListType"
+      class="bk-field-list-item"
+      :uuid="item.uuid"
+      :bundle="item.bundle"
+      :options="item.options"
+      :props="item.props"
+      is-editing
+      :index="i"
+      :parent-type="isNested ? entity.bundle : ''"
+      :data-bk-uuid="item.uuid"
+      :data-bk-is-muted="isMuted(item)"
+    />
+  </Component>
+</template>
+
+<script setup>
+import {
+  computed,
+  useBlokkli,
+  onMounted,
+  onBeforeUnmount,
+  useAttrs,
+  provide,
+  watch,
+  useTemplateRef
+} from "#imports";
+import BlokkliItem from "./../../components/BlokkliItem.vue?blokkliEditing=true";
+import { isVisibleByOptions } from "#blokkli/helpers/runtimeHelpers";
+import {
+  INJECT_FIELD_PROXY_MODE,
+  INJECT_IS_EDITING
+} from "#blokkli/helpers/injections";
+const { dom, selection } = useBlokkli();
+const root = useTemplateRef("root");
+const props = defineProps({
+  name: { type: String, required: true },
+  fieldKey: { type: String, required: true },
+  list: { type: Array, required: true },
+  entity: { type: Object, required: true },
+  language: { type: String, required: false, default: void 0 },
+  tag: { type: String, required: false, default: "div" },
+  isNested: { type: Boolean, required: true },
+  fieldListType: { type: null, required: true },
+  allowedFragments: { type: null, required: false, default: () => {
+    return [];
+  } },
+  dropAlignment: { type: String, required: false, default: void 0 },
+  zIndex: { type: [Number, String], required: false, default: 0 },
+  proxyMode: { type: Boolean, required: false },
+  globalProxyMode: { type: Boolean, required: false },
+  nestingLevel: { type: Number, required: true },
+  shouldRenderItem: { type: Function, required: false, default: void 0 }
+});
+const attrs = useAttrs();
+provide(INJECT_FIELD_PROXY_MODE, props.proxyMode);
+provide(INJECT_IS_EDITING, true);
+const proxyVisible = computed(
+  () => props.proxyMode && (selection.uuids.value.length || selection.isDragging.value || selection.isMultiSelecting.value || selection.hasHostSelected.value)
+);
+function isMuted(item) {
+  if (!item) {
+    return true;
+  }
+  if (!item.editContext?.isPublished) {
+    return true;
+  }
+  const isVisible = isVisibleByOptions(item, props.language);
+  const isVisibleCustom = props.shouldRenderItem ? props.shouldRenderItem(item) : true;
+  return !(isVisible && isVisibleCustom);
+}
+const data = computed(() => {
+  const allowedFragments = Array.isArray(props.allowedFragments) ? props.allowedFragments : [props.allowedFragments];
+  const zIndex = Number(props.zIndex);
+  return {
+    fieldListType: props.fieldListType,
+    allowedFragments,
+    isNested: props.isNested,
+    nestingLevel: props.nestingLevel,
+    dropAlignment: props.dropAlignment ?? null,
+    zIndex: Number.isNaN(zIndex) ? 0 : zIndex
+  };
+});
+watch(
+  () => root.value,
+  function(newRoot) {
+    if (newRoot instanceof HTMLElement) {
+      dom.updateFieldElement(props.entity, props.name, newRoot, data.value);
+    }
+  }
+);
+onMounted(() => {
+  if (root.value instanceof HTMLElement) {
+    dom.registerField(props.entity, props.name, root.value, data.value);
+  }
+});
+onBeforeUnmount(() => {
+  dom.unregisterField(props.entity, props.name);
+});
+defineOptions({
+  inheritAttrs: false
+});
+if (import.meta.hot) {
+  import.meta.hot.accept("#blokkli/helpers/runtimeHelpers", () => {
+  });
+}
+</script>

package/dist/runtime/editor/components/DraggableList.vue.d.ts

@@ -0,0 +1,31 @@
+import type { FieldListItem, EntityContext } from '#blokkli/types';
+import type { BlokkliFragmentName } from '#blokkli-build/definitions';
+import type { FieldListItemTyped, ValidFieldListTypes } from '#blokkli-build/generated-types';
+import type { FieldDropAlignment } from '#blokkli/types/field';
+type __VLS_Props = {
+    name: string;
+    fieldKey: string;
+    list: FieldListItem[];
+    entity: EntityContext;
+    language?: string;
+    tag?: string;
+    isNested: boolean;
+    fieldListType: ValidFieldListTypes;
+    allowedFragments?: BlokkliFragmentName[] | BlokkliFragmentName;
+    dropAlignment?: FieldDropAlignment;
+    zIndex?: number | string;
+    proxyMode?: boolean;
+    globalProxyMode?: boolean;
+    nestingLevel: number;
+    shouldRenderItem?: (item: FieldListItem | FieldListItemTyped) => boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    tag: string;
+    allowedFragments: BlokkliFragmentName[] | BlokkliFragmentName;
+    dropAlignment: FieldDropAlignment;
+    zIndex: number | string;
+    language: string;
+    shouldRenderItem: (item: FieldListItem | FieldListItemTyped) => boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/editor/components/Dropdown/index.d.vue.ts

@@ -0,0 +1,27 @@
+type __VLS_Props = {
+    position?: 'bottom-left' | 'top-left' | 'top-right';
+    disabled?: boolean;
+};
+declare function close(): void;
+declare var __VLS_1: {}, __VLS_9: {
+    close: typeof close;
+};
+type __VLS_Slots = {} & {
+    button?: (props: typeof __VLS_1) => any;
+} & {
+    default?: (props: typeof __VLS_9) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {
+    close: typeof close;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    disabled: boolean;
+    position: "bottom-left" | "top-left" | "top-right";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/editor/components/Dropdown/index.vue

@@ -0,0 +1,107 @@
+<template>
+  <div ref="container" class="bk-dropdown-menu">
+    <button
+      class="bk-dropdown-menu-trigger"
+      :disabled="disabled"
+      @click="showMenu = !showMenu"
+    >
+      <slot name="button" />
+    </button>
+    <BlokkliTransition name="drop-up">
+      <div
+        v-if="showMenu"
+        ref="contentEl"
+        class="bk-dropdown-menu-content"
+        :class="positionClass"
+        @keydown="onContentKeydown"
+      >
+        <slot :close="close" />
+      </div>
+    </BlokkliTransition>
+  </div>
+</template>
+
+<script setup>
+import {
+  ref,
+  computed,
+  watch,
+  nextTick,
+  onMounted,
+  onBeforeUnmount,
+  useTemplateRef,
+  useBlokkli
+} from "#imports";
+import { BlokkliTransition } from "#blokkli/editor/components";
+const props = defineProps({
+  position: { type: String, required: false, default: "bottom-left" },
+  disabled: { type: Boolean, required: false, default: false }
+});
+const { eventBus } = useBlokkli();
+const container = useTemplateRef("container");
+const contentEl = useTemplateRef("contentEl");
+const showMenu = ref(false);
+const positionClass = computed(() => `bk-is-${props.position}`);
+function getFocusableItems() {
+  if (!contentEl.value) return [];
+  return Array.from(
+    contentEl.value.querySelectorAll("button, input, [tabindex]")
+  );
+}
+function focusTrigger() {
+  const trigger = container.value?.querySelector(
+    ".bk-dropdown-menu-trigger"
+  );
+  trigger?.focus();
+}
+function close() {
+  if (!showMenu.value) return;
+  showMenu.value = false;
+  focusTrigger();
+}
+watch(showMenu, (open) => {
+  if (open) {
+    nextTick(() => {
+      const items = getFocusableItems();
+      items[0]?.focus();
+    });
+  }
+});
+function onContentKeydown(e) {
+  const { key } = e;
+  if (key === "Escape") {
+    e.preventDefault();
+    e.stopPropagation();
+    close();
+    return;
+  }
+  if (key === "ArrowDown" || key === "ArrowUp") {
+    e.preventDefault();
+    e.stopPropagation();
+    const items = getFocusableItems();
+    if (!items.length) return;
+    const current = items.indexOf(document.activeElement);
+    let next;
+    if (key === "ArrowDown") {
+      next = current < items.length - 1 ? current + 1 : 0;
+    } else {
+      next = current > 0 ? current - 1 : items.length - 1;
+    }
+    items[next]?.focus();
+    return;
+  }
+  e.stopPropagation();
+}
+function onDocumentClick(e) {
+  if (!container.value?.contains(e.target)) {
+    close();
+  }
+}
+eventBus.on("mouse:up", close);
+onMounted(() => document.addEventListener("click", onDocumentClick));
+onBeforeUnmount(() => {
+  document.removeEventListener("click", onDocumentClick);
+  eventBus.off("mouse:up", close);
+});
+defineExpose({ close });
+</script>

package/dist/runtime/editor/components/Dropdown/index.vue.d.ts

@@ -0,0 +1,27 @@
+type __VLS_Props = {
+    position?: 'bottom-left' | 'top-left' | 'top-right';
+    disabled?: boolean;
+};
+declare function close(): void;
+declare var __VLS_1: {}, __VLS_9: {
+    close: typeof close;
+};
+type __VLS_Slots = {} & {
+    button?: (props: typeof __VLS_1) => any;
+} & {
+    default?: (props: typeof __VLS_9) => any;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {
+    close: typeof close;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    disabled: boolean;
+    position: "bottom-left" | "top-left" | "top-right";
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/editor/components/DropdownItem/index.d.vue.ts

@@ -0,0 +1,13 @@
+import type { BlokkliIcon } from '#blokkli-build/icons';
+type __VLS_Props = {
+    icon: BlokkliIcon;
+    text: string;
+    disabled?: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onClick?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/editor/components/DropdownItem/index.vue

@@ -0,0 +1,16 @@
+<template>
+  <button class="bk-dropdown-menu-item" :disabled @click="$emit('click')">
+    <Icon :name="icon" />
+    <span>{{ text }}</span>
+  </button>
+</template>
+
+<script setup>
+import { Icon } from "#blokkli/editor/components";
+defineProps({
+  icon: { type: null, required: true },
+  text: { type: String, required: true },
+  disabled: { type: Boolean, required: false }
+});
+defineEmits(["click"]);
+</script>

package/dist/runtime/editor/components/DropdownItem/index.vue.d.ts

@@ -0,0 +1,13 @@
+import type { BlokkliIcon } from '#blokkli-build/icons';
+type __VLS_Props = {
+    icon: BlokkliIcon;
+    text: string;
+    disabled?: boolean;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: () => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onClick?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/editor/components/EditIndicator.d.vue.ts

@@ -0,0 +1,15 @@
+import '#blokkli-build/styles.css';
+import type { EditPermission } from '#blokkli/types/provider';
+type __VLS_Props = {
+    uuid: string;
+    entityType: string;
+    editLabel?: string;
+    permissions: Array<EditPermission | null>;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    edit: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onEdit?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/editor/components/EditIndicator.vue

@@ -0,0 +1,151 @@
+<template>
+  <Teleport to="body">
+    <div class="bk">
+      <button
+        ref="button"
+        class="bk-edit-indicator bk-button bk-is-primary"
+        @mouseenter="isHovering = true"
+        @mouseleave="isHovering = false"
+        @click="$emit('edit')"
+      >
+        {{ label }}
+      </button>
+
+      <div
+        v-show="isHovering"
+        ref="overlay"
+        class="bk-edit-indicator-overlay"
+      />
+    </div>
+  </Teleport>
+</template>
+
+<script setup>
+import textProvider from "#blokkli/editor/providers/texts";
+import {
+  ref,
+  onMounted,
+  onBeforeUnmount,
+  useState,
+  computed,
+  useTemplateRef
+} from "#imports";
+import "#blokkli-build/styles.css";
+import { useAnimationFrame } from "#blokkli/editor/composables";
+const props = defineProps({
+  uuid: { type: String, required: true },
+  entityType: { type: String, required: true },
+  editLabel: { type: String, required: false },
+  permissions: { type: Array, required: true }
+});
+const key = computed(() => props.entityType + ":" + props.uuid);
+const $t = textProvider();
+const label = computed(() => {
+  if (props.editLabel) {
+    return props.editLabel;
+  } else if (props.permissions.includes("edit")) {
+    return $t("editIndicatorLabel", "Edit blocks");
+  } else if (props.permissions.includes("review")) {
+    return $t("editIndicatorLabelReview", "Review changes");
+  } else if (props.permissions.includes("view")) {
+    return $t("editIndicatorLabelView", "View changes");
+  }
+  return null;
+});
+defineEmits(["edit"]);
+const isHovering = ref(false);
+const button = useTemplateRef("button");
+const overlay = useTemplateRef("overlay");
+const targetElement = ref(null);
+const indicatorRegistry = useState(
+  "blokkliEditIndicators",
+  () => []
+);
+const isManager = computed(() => {
+  return indicatorRegistry.value[0]?.key === key.value;
+});
+function calculateIdealYPosition(buttonHeight, bounds, gap) {
+  const elementHeight = bounds.bottom - bounds.top;
+  let position;
+  if (elementHeight < 100) {
+    position = bounds.top + elementHeight / 2 - buttonHeight / 2;
+  } else {
+    position = bounds.top + gap;
+  }
+  position = Math.max(position, gap);
+  return Math.min(position, bounds.bottom - buttonHeight - gap);
+}
+const GAP = 15;
+const indicators = computed(() => {
+  const indicators2 = [...indicatorRegistry.value];
+  return indicators2.sort((a, b) => {
+    const position = a.targetElement.compareDocumentPosition(b.targetElement);
+    if (position & Node.DOCUMENT_POSITION_FOLLOWING) {
+      return -1;
+    }
+    if (position & Node.DOCUMENT_POSITION_PRECEDING) {
+      return 1;
+    }
+    return 0;
+  });
+});
+function updateAllIndicatorPositions() {
+  const positions = [];
+  const heights = [];
+  for (let i = 0; i < indicators.value.length; i++) {
+    const data = indicators.value[i];
+    const rect = data.targetElement.getBoundingClientRect();
+    const buttonHeight = data.buttonElement.offsetHeight;
+    let idealY = calculateIdealYPosition(buttonHeight, rect, GAP);
+    for (let j = 0; j < i; j++) {
+      const prevRect = indicators.value[j].targetElement.getBoundingClientRect();
+      const prevElementTop = prevRect.top;
+      const prevElementHeight = prevRect.height;
+      const collisionPosition = prevElementTop + prevElementHeight + GAP;
+      if (idealY < collisionPosition) {
+        idealY = collisionPosition;
+      }
+    }
+    const elementBottom = rect.bottom - buttonHeight - GAP;
+    if (elementBottom < idealY) {
+      idealY = elementBottom;
+    }
+    idealY = Math.round(idealY);
+    positions.push(idealY);
+    heights.push(buttonHeight);
+    data.buttonElement.style.transform = `translateY(${idealY}px)`;
+  }
+}
+onMounted(() => {
+  const el = document.querySelector(`[data-provider-uuid="${props.uuid}"]`);
+  if (el && el instanceof HTMLElement) {
+    targetElement.value = el;
+  }
+  if (button.value && targetElement.value) {
+    indicatorRegistry.value.push({
+      key: key.value,
+      targetElement: targetElement.value,
+      buttonElement: button.value
+    });
+  }
+});
+onBeforeUnmount(() => {
+  indicatorRegistry.value = indicatorRegistry.value.filter(
+    (i) => i.key !== key.value
+  );
+});
+useAnimationFrame(() => {
+  if (!button.value || !targetElement.value) {
+    return;
+  }
+  if (isManager.value) {
+    updateAllIndicatorPositions();
+  }
+  if (isHovering.value && overlay.value) {
+    const rect = targetElement.value.getBoundingClientRect();
+    overlay.value.style.width = rect.width + "px";
+    overlay.value.style.height = rect.height + "px";
+    overlay.value.style.transform = `translate(${rect.x}px, ${rect.y}px)`;
+  }
+});
+</script>

package/dist/runtime/editor/components/EditIndicator.vue.d.ts

@@ -0,0 +1,15 @@
+import '#blokkli-build/styles.css';
+import type { EditPermission } from '#blokkli/types/provider';
+type __VLS_Props = {
+    uuid: string;
+    entityType: string;
+    editLabel?: string;
+    permissions: Array<EditPermission | null>;
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    edit: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onEdit?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/editor/components/EditProvider.d.vue.ts

@@ -0,0 +1,36 @@
+import '#blokkli-build/styles.css';
+import type { EditPermission } from '#blokkli/types/provider';
+import type { ValidProviderTypes } from '#blokkli-build/generated-types';
+declare const __VLS_export: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: import("vue").PublicProps & __VLS_PrettifyLocal<{
+        entity?: T;
+        entityType: string;
+        entityUuid: string;
+        entityBundle: string;
+        language?: string;
+        isolate?: boolean;
+        permissions: Array<EditPermission | null>;
+        providerEl: HTMLElement;
+        providerType: ValidProviderTypes;
+    }> & (typeof globalThis extends {
+        __VLS_PROPS_FALLBACK: infer P;
+    } ? P : {});
+    expose: (exposed: {}) => void;
+    attrs: any;
+    slots: {
+        default(props: {
+            mutatedEntity: T;
+            key: string;
+        }): any;
+    };
+    emit: {};
+}>) => import("vue").VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_PrettifyLocal<T> = (T extends any ? {
+    [K in keyof T]: T[K];
+} : {
+    [K in keyof T as K]: T[K];
+}) & {};