@alpaca-editor/core 1.0.3939 → 1.0.3942

package/src/types.ts

@@ -1,335 +0,0 @@
-import { TextField } from "./editor/fieldTypes";
-import { ItemDescriptor, Version } from "./editor/pageModel";
-
-export type Rendering = {
-  id: string;
-  name: string;
-  icon: string;
-};
-
-export type EditableDictionary = {
-  [key: string]: TextField;
-};
-
-export type ValidationResult = {
-  item: ItemDescriptor;
-  results: SingleValidatorResult[];
-};
-
-export type SingleValidatorResult = {
-  itemId: string;
-  itemName: string;
-  fieldId: string;
-  fieldName: string;
-  validator: string;
-  result: 0 | 1 | 2 | 3 | 4 | 5;
-  message: string;
-};
-
-export type FieldDescriptor = {
-  item: ItemDescriptor;
-  fieldId: string;
-  fieldName?: string;
-};
-
-export type LanguageVersions = {
-  languageCode: string;
-  countryCode: string;
-  name: string;
-  versions: number;
-  icon: string;
-};
-
-export type AiPrompt = {
-  title: string;
-  prompt: string;
-};
-
-export type EditData = {
-  loginUrl: string;
-  aiPrompts: AiPrompt[];
-};
-
-export type EditSession = {
-  sessionId: string;
-  url?: string;
-  user: User;
-  userAgent?: string;
-  page?: ItemDescriptor;
-  item?: ItemDescriptor;
-  fieldLock?: { item: ItemDescriptor; fieldId: string };
-  color: string;
-};
-
-export type EditOperation = {
-  type:
-    | "edit-field"
-    | "remove-component"
-    | "move-component"
-    | "add-component"
-    | "synchronize-components"
-    | "link-component"
-    | "duplicate-components"
-    | "rename-item";
-
-  date: string;
-  id: string;
-  user?: User;
-  undone?: boolean;
-  sessionId?: string;
-  description: string;
-  canUndo?: boolean;
-  canRedo?: boolean;
-  focus?: string;
-  mainItem: ItemDescriptor;
-};
-
-export type RenameItemOperation = EditOperation & {
-  type: "rename-item";
-  item: ItemDescriptor;
-  newName: string;
-  oldName?: string;
-};
-
-export type EditFieldOperation = EditOperation & {
-  type: "edit-field";
-  itemId: string;
-  fieldName: string;
-  fieldId: string;
-  fieldType?: string;
-  value?: any;
-  oldValue?: any;
-};
-
-export type AddComponentOperation = EditOperation & {
-  type: "add-component";
-  componentTypeId: string;
-  placeholderKey: string;
-  placeholderIndex: number;
-  componentId?: string;
-};
-
-export type LinkComponentOperation = EditOperation & {
-  type: "link-component";
-  itemName?: string;
-  linkedComponentItem: ItemDescriptor;
-};
-
-export type MoveComponentOperation = EditOperation & {
-  type: "move-component";
-  placeholderKey: string;
-  placeholderIndex: number;
-  componentIds: string[];
-};
-
-export type DuplicateComponentsOperation = EditOperation & {
-  type: "duplicate-components";
-  componentIds: string[];
-  sourceComponentIds: string[];
-};
-
-export type RemoveComponentOperation = EditOperation & {
-  type: "remove-component";
-  componentIds: string[];
-};
-
-export type SynchronizeComponentsOperation = EditOperation & {
-  type: "synchronize-components";
-  placeholders: PlaceholderToSynchronize[];
-  delete: boolean;
-  itemsCreated?: ItemDescriptor[];
-};
-
-export type PlaceholderToSynchronize = {
-  name?: string;
-  item?: ItemDescriptor | null;
-};
-
-export type View = {
-  name: string;
-};
-
-export type UserInfo = {
-  user: User;
-  views: View[];
-};
-
-export type User = {
-  name: string;
-  displayName?: string;
-  ai: boolean;
-  email?: string;
-  isLimitedPreviewUser?: boolean;
-};
-
-export type HistoryEntry = {
-  name: string;
-  path: string;
-  id: string;
-  version: number;
-  hasLayout: boolean;
-  icon?: string;
-  templateName: string;
-  language: string;
-};
-
-export type FieldHistoryItem = {
-  user: string;
-  date: string;
-  ai: boolean;
-  value: unknown;
-  rawValue: string;
-  version: number;
-  undone: boolean;
-};
-
-export type Site = {
-  name: string;
-};
-
-export type ExecuteEditOptions = {
-  refresh: "none" | "immediate" | "delayed" | "waitForQuietPeriod";
-};
-
-export type Workbox = {
-  items: WorkboxItem[];
-};
-export type WorkboxItem = {
-  item: ItemDescriptor;
-  lockedBy: string;
-  canLock: boolean;
-  hasLock: boolean;
-  publishStatus: {
-    [target: string]: string;
-  };
-  workflowState: string;
-  isFinalState: boolean;
-  isPublishable: boolean;
-  isPublished: boolean;
-  path: string;
-  name: string;
-  workflowCommands: {
-    name: string;
-    id: string;
-  }[];
-};
-
-export type InsertOption = {
-  typeId: string;
-  name: string;
-  icon: string;
-  group?: string;
-  svg?: string;
-  isInvalid: boolean;
-  message?: string;
-  isHidden: any;
-  compatibleTypeIds?: string[];
-};
-
-export type LanguagesAndVersions = {
-  languages: LanguageVersions[];
-  versions: Version[];
-};
-
-export type IndexStatus = {
-  name: string;
-  exists: boolean;
-
-  errors: Error[];
-  hasRebuildJob: boolean;
-  settingsItemId?: string;
-  rebuildJobItemId?: string;
-  serviceUrl?: string;
-  lastRebuildStartDateTime?: Date;
-  languages: {
-    [language: string]: {
-      lastUpdated: Date;
-      numberOfItems: number;
-      status: string;
-    };
-  };
-  canRebuild: boolean;
-  isRunning: boolean;
-  rebuildCount: number;
-  rebuildTokensCount: number;
-};
-
-export type Error = {
-  message: string;
-  details: string;
-};
-
-export type Comment = {
-  id: string;
-  isNew: boolean;
-  itemId: string;
-  itemName?: string;
-  mainItemId: string;
-  language: string;
-  version: number;
-  fieldId?: string;
-  fieldName?: string;
-  text?: string;
-  fieldValue?: string | null;
-  rangeStart?: number;
-  rangeEnd?: number;
-  author?: string;
-  authorDisplayName?: string;
-  created?: string;
-  isResolved?: boolean;
-  resolvedBy?: string;
-  resolvedDate?: string;
-  position: number;
-};
-
-export type Reviewer = {
-  name: string;
-  email: string;
-};
-
-export type Review = {
-  id: string;
-  reviewerName: string;
-  reviewerEmail: string;
-  itemId: string;
-  language: string;
-  version: number;
-  invitationSentDate?: string;
-  approvalDate?: string;
-  rejectedDate?: string;
-};
-
-export type SystemStatusMessage = {
-  message: string;
-  severity: "info" | "warning" | "error";
-};
-
-export type SystemStatus = {
-  messages: SystemStatusMessage[];
-};
-
-export interface SuggestedEdit {
-  id: string;
-  mainItemId: string;
-  mainItemLanguage: string;
-  mainItemVersion: number;
-  itemId: string;
-  fieldId: string;
-  oldValue: string;
-  newValue: string;
-  author?: string;
-  authorDisplayName?: string;
-  created?: string;
-  status: string;
-  updatedBy?: string;
-  updated?: string;
-  comments?: string;
-  type: string;
-}
-
-export type ContentEditorWarning = {
-  title: string;
-  text: string;
-  icon?: string;
-  isExclusive?: boolean;
-};