@alpaca-editor/core 1.0.3939 → 1.0.3942

package/src/editor/client/GenericDialog.tsx

@@ -1,50 +0,0 @@
-import { Dialog } from "primereact/dialog";
-
-import { forwardRef, useImperativeHandle, useState } from "react";
-
-export interface GenericDialogHandle {
-  show: (props: {
-    title: string;
-    content: React.ReactNode;
-    width?: string;
-    height?: string;
-  }) => void;
-  hide: () => void;
-}
-
-export const GenericDialog = forwardRef<GenericDialogHandle>((_, ref) => {
-  const [content, setContent] = useState<React.ReactNode>(null);
-  const [title, setTitle] = useState<string>("");
-  const [width, setWidth] = useState<string>("50vw");
-  const [height, setHeight] = useState<string>("50vh");
-  const [visible, setVisible] = useState<boolean>(false);
-
-  const show = (props: {
-    title: string;
-    content: React.ReactNode;
-    width?: string;
-    height?: string;
-  }) => {
-    setTitle(props.title);
-    setContent(props.content);
-    if (props.width) setWidth(props.width);
-    if (props.height) setHeight(props.height);
-    setVisible(true);
-  };
-
-  useImperativeHandle(ref, () => ({
-    show,
-    hide: () => setVisible(false),
-  }));
-
-  return (
-    <Dialog
-      onHide={() => setVisible(false)}
-      visible={visible}
-      header={title}
-      style={{ width, height }}
-    >
-      {content}
-    </Dialog>
-  );
-});

package/src/editor/client/editContext.ts

@@ -1,416 +0,0 @@
-"use client";
-
-import React, {
-  MouseEvent,
-  ReactNode,
-  useContext,
-  useEffect,
-  useRef,
-} from "react";
-import { ToastMessage } from "primereact/toast";
-
-import { EditorConfiguration, EditorView } from "../../config/types";
-import {
-  FieldAction,
-  InsertingState,
-  QuotaInfo,
-  WebSocketMessage,
-} from "./EditorClient";
-import { MenuItem } from "primereact/menuitem";
-import { Command, CommandData } from "../commands/commands";
-import { ComponentDetails } from "../services/componentDesignerService";
-import { PageViewContext } from "../page-viewer/pageViewContext";
-import {
-  EditOperation,
-  EditSession,
-  FieldDescriptor,
-  HistoryEntry,
-  InsertOption,
-  LanguageVersions,
-  User,
-  ValidationResult,
-  Comment,
-  WorkboxItem,
-  Review,
-  AddComponentOperation,
-  SuggestedEdit,
-  UserInfo,
-} from "../../types";
-
-import { ConfirmationProps } from "../ConfirmationDialog";
-import {
-  Component,
-  FieldButton,
-  ItemDescriptor,
-  Page,
-  Timings,
-  FullItem,
-  Version,
-  Field,
-} from "../pageModel";
-import { ItemsRepository } from "./itemsRepository";
-import { MediaSelectorMode } from "../media-selector/MediaSelector";
-import { ComponentCommand } from "../commands/componentCommands";
-import { AiTerminalOptions } from "../ai/AiTerminal";
-import {
-  Wizard,
-  WizardData,
-  WizardPageModel,
-} from "../../page-wizard/PageWizard";
-export type DragObject = {
-  type: "template" | "component" | "link-component" | "items";
-  typeId: string;
-  templateId?: string;
-  name?: string;
-  component?: ItemDescriptor;
-  items?: ItemDescriptor[];
-};
-
-export type SelectionRange = {
-  itemId: string;
-  fieldId: string;
-  startOffset: number;
-  endOffset: number;
-  text: string;
-};
-
-export type DialogProps<T> = {
-  onClose: (result: T | null) => void;
-};
-export type OpenDialog = <T, P>(
-  Component: React.ComponentType<P & DialogProps<T>>,
-  props: P,
-) => Promise<T | null>;
-
-export type EditorMode = "edit" | "preview" | "suggestions";
-
-export type EditContextType = {
-  operations: {
-    moveItems: (
-      items: ItemDescriptor[],
-      target: ItemDescriptor,
-      index: number,
-    ) => Promise<void>;
-    copyItems: (
-      items: ItemDescriptor[],
-      target: ItemDescriptor,
-      index: number,
-    ) => Promise<ItemDescriptor[]>;
-    duplicateItem: (
-      item: ItemDescriptor,
-      target: ItemDescriptor,
-      name: string,
-    ) => Promise<ItemDescriptor | undefined>;
-    addComponent: (
-      componentTypeId: string,
-      placeholderKey: string,
-      index: number,
-      pageItem: ItemDescriptor,
-    ) => Promise<AddComponentOperation | undefined>;
-
-    duplicateComponents: ({ componentIds }: { componentIds: string[] }) => void;
-
-    ensureLock: (field: FieldDescriptor) => Promise<boolean>;
-    lockItems: (item: ItemDescriptor[]) => void;
-    unlockItems: (item: ItemDescriptor[]) => void;
-    editField: (props: {
-      field: FieldDescriptor;
-      value?: any;
-      rawValue?: string | null;
-      refresh?: "none" | "immediate" | "delayed" | "waitForQuietPeriod";
-    }) => Promise<void>;
-    undo: (numOperations?: number) => Promise<boolean>;
-    redo: () => Promise<boolean>;
-    executeEditOperation: (operation: EditOperation) => void;
-    executeWorkflowCommand: (
-      item: ItemDescriptor,
-      commandId: string,
-    ) => Promise<void>;
-    renameItem: (item: ItemDescriptor, newName: string) => Promise<void>;
-    deleteItems: (items: ItemDescriptor[]) => Promise<void>;
-    createItem: (
-      parent: ItemDescriptor,
-      templateId: string,
-      name: string,
-    ) => Promise<ItemDescriptor | undefined>;
-    createVersion: (item: ItemDescriptor) => Promise<void>;
-    undoing: boolean;
-  };
-  comments: Comment[];
-  suggestedEdits: SuggestedEdit[];
-  loadComments: () => void;
-  setComments: React.Dispatch<React.SetStateAction<Comment[]>>;
-  selectedComment: Comment | undefined;
-  setSelectedComment: React.Dispatch<React.SetStateAction<Comment | undefined>>;
-  showComments: boolean;
-  setShowComments: React.Dispatch<React.SetStateAction<boolean>>;
-  addComment: () => void;
-  item?: FullItem;
-
-  workboxItems: WorkboxItem[];
-
-  itemLanguages: LanguageVersions[];
-  itemVersions: Version[];
-  view?: EditorView;
-
-  viewName: string;
-  switchView: (
-    viewName: string,
-    options?: { skipConfirmation?: boolean },
-  ) => void;
-  compareMode: boolean;
-  setCompareMode: (compareMode: boolean) => void;
-
-  mode: EditorMode;
-  setMode: React.Dispatch<React.SetStateAction<EditorMode>>;
-
-  showSuggestedEdits: boolean;
-  setShowSuggestedEdits: React.Dispatch<React.SetStateAction<boolean>>;
-  showSuggestedEditsDiff: boolean;
-  setShowSuggestedEditsDiff: React.Dispatch<React.SetStateAction<boolean>>;
-  setCenterPanelView: (view: ReactNode) => void;
-  configuration: EditorConfiguration;
-  showToast: (message: ToastMessage | ToastMessage[]) => void;
-  sessionId: string;
-  openSplashScreen: () => void;
-  getComponentCommands: (component: Component[]) => Promise<ComponentCommand[]>;
-  selectMedia: ({
-    selectedIdPath,
-    mode,
-  }: {
-    selectedIdPath: string;
-    mode: MediaSelectorMode;
-  }) => Promise<string | null>;
-
-  updateUrl: (params: Record<string, string>) => void;
-
-  selection: string[];
-  select: (ids: string[]) => void;
-  selectedForInsertion: string;
-  selectedRange?: SelectionRange;
-  setSelectedRange: React.Dispatch<
-    React.SetStateAction<SelectionRange | undefined>
-  >;
-
-  setSelectedForInsertion: React.Dispatch<React.SetStateAction<string>>;
-  insertMode: boolean;
-  setInsertMode: React.Dispatch<React.SetStateAction<boolean>>;
-  inserting: InsertingState | undefined;
-
-  dragStart: (dragObject: DragObject) => void;
-  dragEnd: () => void;
-  dragObject?: DragObject;
-  refreshCompletedFlag: boolean;
-  isRefreshing: boolean;
-  openCreatePageDialog: () => void;
-
-  reviews: {
-    reviews: Review[];
-    loadReviews: () => void;
-  };
-
-  droppedInPlaceholder: (
-    placeholderKey: string,
-    index: number,
-    spotPositionElement?: Element,
-    spotPositionAnchor?: "left" | "right" | "top" | "bottom",
-    insertOption?: InsertOption,
-  ) => void;
-
-  lockedField: FieldDescriptor | undefined;
-  requestRefresh: (
-    mode?: "immediate" | "delayed" | "waitForQuietPeriod",
-  ) => void;
-  page?: Page;
-
-  currentItemDescriptor?: ItemDescriptor;
-
-  setScrollIntoView: React.Dispatch<React.SetStateAction<string | undefined>>;
-  scrollIntoView?: string;
-  focusedField?: FieldDescriptor;
-  setFocusedField: (
-    field: FieldDescriptor | undefined,
-    requestLock: boolean,
-  ) => Promise<boolean>;
-  unlockField: (field: FieldDescriptor) => void;
-
-  readonly: boolean;
-  triggerFieldAction: (
-    field: FieldDescriptor,
-    action: FieldButton,
-    parameters?: Record<string, string>,
-  ) => void;
-  activeFieldActions: FieldAction[];
-  showContextMenu(e: any, menuItems: MenuItem[]): void;
-  setCurrentOverlay: React.Dispatch<React.SetStateAction<any>>;
-  currentOverlay?: any;
-
-  showAiPopup: (
-    event: MouseEvent<HTMLElement>,
-    aiTerminalOptions?: AiTerminalOptions,
-  ) => void;
-  showFieldEditorPopup: (fields: Field[], sections: string[], ev: any) => void;
-  validationResult: ValidationResult[] | undefined;
-  contentEditorItem: FullItem | undefined;
-
-  loadItem: (
-    itemToLoad: ItemDescriptor | string,
-    options?: { addToBrowseHistory?: boolean },
-  ) => Promise<FullItem | undefined>;
-  editHistory: EditOperation[];
-  activeSessions: EditSession[];
-  validating: boolean;
-  isCommandDisabled: <T extends CommandData>({
-    command,
-    data,
-  }: {
-    command: Command<T>;
-    data?: T;
-  }) => boolean;
-
-  executeCommand: <T extends CommandData>({
-    command,
-    data,
-    event,
-  }: {
-    command: Command<T>;
-    data?: T;
-    event?: React.SyntheticEvent;
-  }) => Promise<any>;
-
-  componentDesignerComponent: ComponentDetails | undefined;
-  setComponentDesignerComponent: React.Dispatch<
-    React.SetStateAction<ComponentDetails | undefined>
-  >;
-  componentDesignerRendering: FullItem | undefined;
-  setComponentDesignerRendering: React.Dispatch<
-    React.SetStateAction<FullItem | undefined>
-  >;
-  inlineEditingFieldElement?: HTMLElement;
-  setInlineEditingFieldElement: React.Dispatch<
-    React.SetStateAction<HTMLElement | undefined>
-  >;
-  timings: Timings;
-  setTimings: React.Dispatch<React.SetStateAction<Timings>>;
-  pageView: PageViewContext;
-
-  confirm: (props: ConfirmationProps) => void;
-  showMessageDialog: (props: { header: string; message: string }) => void;
-
-  itemsRepository: ItemsRepository;
-  browseHistory: HistoryEntry[];
-  handleKeyDown: (event: KeyboardEvent) => void;
-  startTour: () => void;
-
-  addSocketMessageListener: (
-    callback: (message: { type: string; payload: any }) => void,
-  ) => () => void;
-  compareTo?: ItemDescriptor;
-  setCompareTo: React.Dispatch<
-    React.SetStateAction<ItemDescriptor | undefined>
-  >;
-  lastEditedFields: EditedField[];
-  revision?: string;
-  user?: User;
-  statusMessage: React.ReactNode;
-  setStatusMessage: React.Dispatch<React.SetStateAction<React.ReactNode>>;
-
-  enableCompletions: boolean;
-  setEnableCompletions: React.Dispatch<React.SetStateAction<boolean>>;
-  quotaInfo: QuotaInfo | null;
-  isQuotaExceeded: boolean;
-  getQuotaWarningMessage: () => string | null;
-  isMobile: boolean;
-
-  openDialog: OpenDialog;
-
-  pageWizard: {
-    wizard: Wizard | undefined;
-    setWizard: React.Dispatch<React.SetStateAction<Wizard | undefined>>;
-    parentItem: ItemDescriptor | undefined;
-    setParentItem: React.Dispatch<
-      React.SetStateAction<ItemDescriptor | undefined>
-    >;
-    // Wizard step state
-    currentStepIndex: number;
-    setCurrentStepIndex: React.Dispatch<React.SetStateAction<number>>;
-    data: WizardData;
-    setData: React.Dispatch<React.SetStateAction<WizardData>>;
-    pageModel: WizardPageModel;
-    setPageModel: React.Dispatch<React.SetStateAction<WizardPageModel>>;
-    internalState: any;
-    setInternalState: React.Dispatch<React.SetStateAction<any>>;
-    stepCompleted: number;
-    setStepCompleted: React.Dispatch<React.SetStateAction<number>>;
-    pageItem: ItemDescriptor | undefined;
-    setPageItem: React.Dispatch<
-      React.SetStateAction<ItemDescriptor | undefined>
-    >;
-    beforeNextCallbackRef: React.MutableRefObject<
-      (() => Promise<boolean>) | null
-    >;
-  };
-
-  webSocketMessages: WebSocketMessage[];
-  clearWebSocketMessages: () => void;
-  userInfo: UserInfo;
-};
-
-const EditContext = React.createContext<EditContextType | undefined>(undefined);
-export const EditContextProvider = EditContext.Provider;
-
-export const useEditContext = () => useContext(EditContext);
-
-export function useEditContextRef() {
-  const contextValue = useEditContext();
-  const contextRef = useRef(contextValue);
-
-  useEffect(() => {
-    contextRef.current = contextValue;
-  }, [contextValue]);
-
-  return contextRef;
-}
-
-export type EditButton = {
-  id: string;
-  icon: React.ReactNode;
-  onClick: (ev: MouseEvent) => void;
-  label: string;
-};
-
-export type ModifiedField = FieldDescriptor & {
-  value: string | null;
-  isDirty: boolean;
-  modifiedBy: User;
-  timestamp: number;
-};
-
-export type ModifiedFieldsContextType = {
-  modifiedFields: ModifiedField[];
-  clear: () => void;
-};
-
-export type EditedField = FieldDescriptor & {
-  timestamp: number;
-  user: User;
-};
-
-const ModifiedFieldsContext = React.createContext<
-  ModifiedFieldsContextType | undefined
->(undefined);
-
-export const useModifiedFieldsContext = () => useContext(ModifiedFieldsContext);
-export const ModifiedFieldsContextProvider = ModifiedFieldsContext.Provider;
-
-export type OperationsContextType = {
-  executingEditOperations: EditOperation[];
-  editOperationExecuted: EditOperation | undefined;
-};
-
-const OperationsContext = React.createContext<
-  OperationsContextType | undefined
->(undefined);
-
-export const useOperationsContext = () => useContext(OperationsContext);
-export const OperationsContextProvider = OperationsContext.Provider;

package/src/editor/client/helpers.ts

@@ -1,44 +0,0 @@
-import { EditorConfiguration } from "../../config/types";
-import { ConfirmationDialogHandle } from "../ConfirmationDialog";
-import { ExecutionResult } from "../services/editService";
-
-export function handleErrorResult(
-  result: ExecutionResult<unknown>,
-  ui: {
-    showErrorToast: (error: { summary: string; details: string }) => void;
-    confirmationDialogRef: React.RefObject<ConfirmationDialogHandle | null>;
-  },
-  state: {
-    configuration: EditorConfiguration;
-  }
-) {
-  if (result.type === "error") {
-    console.log("show error toast", result);
-
-    ui.showErrorToast({
-      summary: result.summary || "Error",
-      details: result.details || "An error occurred",
-    });
-    return true;
-  }
-
-  if (result.type === "unauthorized") {
-    if (state.configuration.events.onUnauthorized) {
-      state.configuration.events.onUnauthorized();
-      return true;
-    }
-
-    ui.confirmationDialogRef.current?.confirm({
-      header: "Not logged in",
-      message: "You are not logged in anymore. Proceed to login page?",
-      accept: () => {
-        window.location.href = "/sitecore/login";
-      },
-    });
-    ui.showErrorToast({
-      summary: result.summary || "Error",
-      details: result.details || "An error occurred",
-    });
-    return true;
-  }
-}