@case-framework/survey-core 0.1.0

package/build/editor.d.mts

@@ -0,0 +1,245 @@
+import { S as RawSurveyItem, a as JsonComponentContent, i as RawSurvey, n as ItemTypeRegistry, t as Survey, u as SurveyItemTranslations, w as SurveyItemCore } from "./survey-TUPUXiXl.mjs";
+
+//#region src/editor/types.d.ts
+interface Target {
+  parentId: string;
+  index?: number;
+}
+//#endregion
+//#region src/editor/item-copy-paste.d.ts
+type SerializedTranslations = {
+  [locale: string]: JsonComponentContent;
+};
+interface SurveyItemClipboardData {
+  type: 'survey-item';
+  version: string;
+  items: Array<{
+    itemId: string;
+    itemData: RawSurveyItem;
+  }>;
+  translations: {
+    [itemId: string]: SerializedTranslations;
+  };
+  rootItemId: string;
+  timestamp: number;
+}
+declare class ItemCopyPaste {
+  private survey;
+  constructor(survey: Survey);
+  /**
+   * Copy a survey item and all its data to clipboard format
+   * When copying a group, automatically includes all items in the subtree
+   * @param itemId - The id of the item to copy
+   * @returns Clipboard data that can be serialized to JSON for clipboard
+   */
+  copyItem(itemId: string): SurveyItemClipboardData;
+  /**
+   * Collect all items that should be copied, including subtree for groups
+   * @param itemId - The root item id
+   * @returns Array of item keys to copy
+   */
+  private collectItemsForCopy;
+  /**
+   * Add an item to its parent group.
+   * Ensures key uniqueness among siblings.
+   * @param target - Target location information
+   * @param item - The item to add (may have key adjusted for uniqueness)
+   */
+  private addItemToParentGroup;
+  /**
+   * Paste a survey item from clipboard data to a target location
+   * Handles multiple items and subtrees from the clipboard data
+   * @param clipboardData - The clipboard data containing the item(s) to paste
+   * @param target - Target location where to paste the item
+   * @returns The id of the pasted root item
+   */
+  pasteItem(clipboardData: SurveyItemClipboardData, target: Target): string;
+  /**
+   * Update all item ids in the raw item data recursively
+   */
+  private updateItemIdsInData;
+  /**
+   * Update expressions in item data that reference the old ids
+   */
+  private updateExpressionsInItemData;
+  /**
+   * Update references in a single expression (recursive)
+   */
+  private updateExpressionReferences;
+  /**
+  * Update translation keys for the pasted item
+  */
+  private updateTranslations;
+  /**
+  * Validate clipboard data format
+  */
+  static isValidClipboardData(data: unknown): data is SurveyItemClipboardData;
+}
+//#endregion
+//#region src/editor/undo-redo.d.ts
+interface UndoRedoConfig {
+  maxTotalMemoryMB: number;
+  minHistorySize: number;
+  maxHistorySize: number;
+}
+declare const CommitSource: {
+  readonly USER: "user";
+  readonly SYSTEM: "system";
+};
+type CommitSource = typeof CommitSource[keyof typeof CommitSource];
+interface CommitMeta {
+  label: string;
+  source?: CommitSource;
+}
+interface HistoryEntry {
+  survey: RawSurvey;
+  timestamp: number;
+  meta: CommitMeta;
+  memorySize: number;
+}
+declare class SurveyEditorUndoRedo {
+  private history;
+  private currentIndex;
+  private _config;
+  constructor(initialSurvey: RawSurvey, config?: Partial<UndoRedoConfig>, meta?: CommitMeta);
+  private saveSnapshot;
+  private cleanupHistory;
+  private getTotalMemoryUsage;
+  commit(survey: RawSurvey, meta: CommitMeta): void;
+  getCurrentState(): RawSurvey;
+  undo(): RawSurvey | null;
+  redo(): RawSurvey | null;
+  canUndo(): boolean;
+  canRedo(): boolean;
+  getUndoMeta(): CommitMeta | null;
+  getRedoMeta(): CommitMeta | null;
+  getMemoryUsage(): {
+    totalMB: number;
+    entries: number;
+  };
+  getConfig(): UndoRedoConfig;
+  /**
+   * Get the full history list with metadata
+   */
+  getHistory(): Array<{
+    index: number;
+    meta: CommitMeta;
+    timestamp: number;
+    memorySize: number;
+    isCurrent: boolean;
+  }>;
+  /**
+   * Get the current index in the history
+   */
+  getCurrentIndex(): number;
+  /**
+   * Get the total number of history entries
+   */
+  getHistoryLength(): number;
+  /**
+   * Jump to a specific index in the history (can go forward or backward)
+   * @param targetIndex The index to jump to
+   * @returns The survey state at the target index, or null if invalid
+   */
+  jumpToIndex(targetIndex: number): RawSurvey | null;
+  /**
+   * Check if we can jump to a specific index
+   */
+  canJumpToIndex(targetIndex: number): boolean;
+  /**
+   * Serialize the undo/redo state to JSON
+   * @returns A JSON-serializable object containing the complete state
+   */
+  serialize(): {
+    history: Array<HistoryEntry>;
+    currentIndex: number;
+    config: UndoRedoConfig;
+  };
+  /**
+   * Create a new SurveyEditorUndoRedo instance from JSON data
+   * @param jsonData The serialized undo/redo state
+   * @returns A new SurveyEditorUndoRedo instance with the restored state
+   */
+  static deserialize(jsonData: {
+    history: Array<{
+      survey: RawSurvey;
+      timestamp: number;
+      meta: CommitMeta;
+      memorySize: number;
+    }>;
+    currentIndex: number;
+    config: UndoRedoConfig;
+  }): SurveyEditorUndoRedo;
+}
+//#endregion
+//#region src/editor/survey-editor.d.ts
+interface SerializedSurveyEditor {
+  version: string;
+  survey: RawSurvey;
+  undoRedo: ReturnType<SurveyEditorUndoRedo['serialize']>;
+  hasUncommittedChanges: boolean;
+}
+interface SurveyEditorConfig extends Partial<UndoRedoConfig> {
+  /** Plugin registry for deserializing survey state during undo/redo. Required when survey contains custom item types. */
+  pluginRegistry?: ItemTypeRegistry;
+}
+declare class SurveyEditor {
+  private _survey;
+  private _undoRedo;
+  private _hasUncommittedChanges;
+  private _pluginRegistry?;
+  constructor(survey: Survey, config?: SurveyEditorConfig, meta?: CommitMeta);
+  get survey(): Survey;
+  get hasUncommittedChanges(): boolean;
+  get undoRedo(): SurveyEditorUndoRedo;
+  commit(meta: CommitMeta): void;
+  commitIfNeeded(): void;
+  undo(): boolean;
+  redo(): boolean;
+  /**
+   * Jump to a specific index in the history (can go forward or backward)
+   */
+  jumpToIndex(targetIndex: number): boolean;
+  canUndo(): boolean;
+  canRedo(): boolean;
+  getUndoMeta(): CommitMeta | null;
+  getRedoMeta(): CommitMeta | null;
+  getMemoryUsage(): {
+    totalMB: number;
+    entries: number;
+  };
+  getUndoRedoConfig(): UndoRedoConfig;
+  /**
+   * Serialize the SurveyEditor state to JSON
+   * @returns A JSON-serializable object containing the complete editor state
+   */
+  toJson(): SerializedSurveyEditor;
+  /**
+   * Create a new SurveyEditor instance from JSON data
+   * @param jsonData The serialized editor state
+   * @param pluginRegistry Optional plugin registry for deserializing survey state (required when survey contains custom item types)
+   * @returns A new SurveyEditor instance with the restored state
+   */
+  static fromJson(jsonData: SerializedSurveyEditor, pluginRegistry?: ItemTypeRegistry): SurveyEditor;
+  private markAsModified;
+  addItem(target: Target, item: SurveyItemCore, content?: SurveyItemTranslations): void;
+  removeItem(itemId: string, nested?: boolean): boolean;
+  moveItem(itemId: string, newTarget: Target): boolean;
+  updateItemTranslations(itemId: string, updatedContent?: SurveyItemTranslations): boolean;
+  /**
+   * Copy a survey item and all its data to clipboard format
+   * @param itemKey - The full key of the item to copy
+   * @returns Clipboard data that can be serialized to JSON for clipboard
+   */
+  copyItem(itemKey: string): SurveyItemClipboardData;
+  /**
+   * Paste a survey item from clipboard data to a target location
+   * @param clipboardData - The clipboard data containing the item to paste
+   * @param target - Target location where to paste the item
+   * @returns The full key of the pasted item
+   */
+  pasteItem(clipboardData: SurveyItemClipboardData, target: Target): string;
+}
+//#endregion
+export { CommitMeta, CommitSource, ItemCopyPaste, SerializedSurveyEditor, SerializedTranslations, SurveyEditor, SurveyEditorConfig, SurveyEditorUndoRedo, SurveyItemClipboardData, Target, UndoRedoConfig };
+//# sourceMappingURL=editor.d.mts.map

package/build/editor.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.d.mts","names":[],"sources":["../src/editor/types.ts","../src/editor/item-copy-paste.ts","../src/editor/undo-redo.ts","../src/editor/survey-editor.ts"],"mappings":";;;UAAiB,MAAA;EACb,QAAA;EACA,KAAA;AAAA;;;KCSQ,sBAAA;EAAA,CACT,MAAA,WAAiB,oBAAA;AAAA;AAAA,UAIH,uBAAA;EACf,IAAA;EACA,OAAA;EACA,KAAA,EAAO,KAAA;IACL,MAAA;IACA,QAAA,EAAU,aAAA;EAAA;EAEZ,YAAA;IAAA,CAAiB,MAAA,WAAiB,sBAAA;EAAA;EAClC,UAAA;EACA,SAAA;AAAA;AAAA,cAIW,aAAA;EAAA,QACH,MAAA;cAEI,MAAA,EAAQ,MAAA;EAToC;;;;;;EAmBxD,QAAA,CAAS,MAAA,WAAiB,uBAAA;EArBd;;;;;EAAA,QA6EJ,mBAAA;EAzEC;;AAIX;;;;EAJW,QAqGD,oBAAA;EAiDiB;;;;;;;EAAzB,SAAA,CAAU,aAAA,EAAe,uBAAA,EAAyB,MAAA,EAAQ,MAAA;EA/I9C;;;EAAA,QAgMJ,mBAAA;EA9HA;;;EAAA,QA+IA,2BAAA;EAlEE;;;EAAA,QAgGF,0BAAA;EA9BA;;;EAAA,QAiEA,kBAAA;EAqBoB;;;EAAA,OAArB,oBAAA,CAAqB,IAAA,YAAgB,IAAA,IAAQ,uBAAA;AAAA;;;UCpUrC,cAAA;EACf,gBAAA;EACA,cAAA;EACA,cAAA;AAAA;AAAA,cAGW,YAAA;EAAA,SAGH,IAAA;EAAA,SAAA,MAAA;AAAA;AAAA,KACE,YAAA,UAAsB,YAAA,cAA0B,YAAA;AAAA,UAE3C,UAAA;EACf,KAAA;EACA,MAAA,GAAS,YAAA;AAAA;AAAA,UAID,YAAA;EACR,MAAA,EAAQ,SAAA;EACR,SAAA;EACA,IAAA,EAAM,UAAA;EACN,UAAA;AAAA;AAAA,cA2BW,oBAAA;EAAA,QACH,OAAA;EAAA,QACA,YAAA;EAAA,QACA,OAAA;cAEI,aAAA,EAAe,SAAA,EAAW,MAAA,GAAQ,OAAA,CAAQ,cAAA,GAAsB,IAAA,GAAM,UAAA;EAAA,QAY1E,YAAA;EAAA,QAoBA,cAAA;EAAA,QAiBA,mBAAA;EAKR,MAAA,CAAO,MAAA,EAAQ,SAAA,EAAW,IAAA,EAAM,UAAA;EAKhC,eAAA,CAAA,GAAmB,SAAA;EAOnB,IAAA,CAAA,GAAQ,SAAA;EAOR,IAAA,CAAA,GAAQ,SAAA;EAOR,OAAA,CAAA;EAIA,OAAA,CAAA;EAIA,WAAA,CAAA,GAAe,UAAA;EAKf,WAAA,CAAA,GAAe,UAAA;EAKf,cAAA,CAAA;IAAoB,OAAA;IAAiB,OAAA;EAAA;EAOrC,SAAA,CAAA,GAAa,cAAA;EDxHa;;;EC+H1B,UAAA,CAAA,GAAc,KAAA;IACZ,KAAA;IACA,IAAA,EAAM,UAAA;IACN,SAAA;IACA,UAAA;IACA,SAAA;EAAA;EDpIF;;;ECkJA,eAAA,CAAA;ED9DQ;;;ECqER,gBAAA,CAAA;EDpB0D;;;;;EC6B1D,WAAA,CAAY,WAAA,WAAsB,SAAA;ED2H3B;;;EC/GP,cAAA,CAAe,WAAA;ED+G4D;;;;ECvG3E,SAAA,CAAA;IACE,OAAA,EAAS,KAAA,CAAM,YAAA;IACf,YAAA;IACA,MAAA,EAAQ,cAAA;EAAA;EA/NV;;;;;EAAA,OAkPO,WAAA,CAAY,QAAA;IACjB,OAAA,EAAS,KAAA;MACP,MAAA,EAAQ,SAAA;MACR,SAAA;MACA,IAAA,EAAM,UAAA;MACN,UAAA;IAAA;IAEF,YAAA;IACA,MAAA,EAAQ,cAAA;EAAA,IACN,oBAAA;AAAA;;;UCnPW,sBAAA;EACf,OAAA;EACA,MAAA,EAAQ,SAAA;EACR,QAAA,EAAU,UAAA,CAAW,oBAAA;EACrB,qBAAA;AAAA;AAAA,UAIe,kBAAA,SAA2B,OAAA,CAAQ,cAAA;EFRZ;EEUtC,cAAA,GAAiB,gBAAA;AAAA;AAAA,cAGN,YAAA;EAAA,QACH,OAAA;EAAA,QACA,SAAA;EAAA,QACA,sBAAA;EAAA,QACA,eAAA;cAGN,MAAA,EAAQ,MAAA,EACR,MAAA,GAAQ,kBAAA,EACR,IAAA,GAAO,UAAA;EAAA,IAQL,MAAA,CAAA,GAAU,MAAA;EAAA,IAIV,qBAAA,CAAA;EAAA,IAKA,QAAA,CAAA,GAAY,oBAAA;EAKhB,MAAA,CAAO,IAAA,EAAM,UAAA;EAKb,cAAA,CAAA;EAUA,IAAA,CAAA;EAmBA,IAAA,CAAA;EFnEA;;;EEsFA,WAAA,CAAY,WAAA;EAeZ,OAAA,CAAA;EAIA,OAAA,CAAA;EAIA,WAAA,CAAA,GAAe,UAAA;EAUf,WAAA,CAAA,GAAe,UAAA;EAQf,cAAA,CAAA;IAAoB,OAAA;IAAiB,OAAA;EAAA;EAKrC,iBAAA,CAAA,GAAqB,cAAA;EFoBqC;;;;EEZ1D,MAAA,CAAA,GAAU,sBAAA;;;;;;;SAeH,QAAA,CAAS,QAAA,EAAU,sBAAA,EAAwB,cAAA,GAAiB,gBAAA,GAAmB,YAAA;EAAA,QAiC9E,cAAA;EAIR,OAAA,CACE,MAAA,EAAQ,MAAA,EACR,IAAA,EAAM,cAAA,EACN,OAAA,GAAU,sBAAA;EAsEZ,UAAA,CAAW,MAAA,UAAgB,MAAA;EAiC3B,QAAA,CAAS,MAAA,UAAgB,SAAA,EAAW,MAAA;EAyDpC,sBAAA,CAAuB,MAAA,UAAgB,cAAA,GAAiB,sBAAA;EF3MN;;;;;EE4NlD,QAAA,CAAS,OAAA,WAAkB,uBAAA;EFpEC;;;;;;EE+E5B,SAAA,CAAU,aAAA,EAAe,uBAAA,EAAyB,MAAA,EAAQ,MAAA;AAAA"}