@pierre/diffs 1.3.0-beta.8 → 1.3.0-rc.1

package/dist/editor/editor.d.ts

@@ -1,13 +1,24 @@
-import { DiffLineAnnotation, DiffsEditableComponent, DiffsEditor, DiffsEditorSelection, FileContents, RenderRange } from "../types.js";
-import { TextEdit } from "./textDocument.js";
-import { AutoSurround, EditorSelection } from "./selection.js";
+import { DiffLineAnnotation, DiffsEditableComponent, DiffsEditor, EditableInstance, EditorState, FileContents, LineAnnotation, Range, TextEdit } from "../types.js";
+import { LanguageConfigMap } from "./languages.js";
 import { Marker } from "./marker.js";
+import { AutoSurround } from "./selection.js";
 import { SelectionActionContext } from "./selectionAction.js";
+import { PersistStateStorage } from "./stateStorage.js";
 
 //#region src/editor/editor.d.ts
 interface EditorOptions<LAnnotation> {
   /** The maximum number of entries to keep in the undo stack. */
   historyMaxEntries?: number;
+  /**
+   * Preserve each file's document and item-local editor state when switching files.
+   * Every editable file must provide a unique, stable `cacheKey`.
+   */
+  persistState?: boolean;
+  /**
+   * Storage for serializable editor state. Text documents stay in this Editor's
+   * in-memory cache. Defaults to `"inMemory"`.
+   */
+  persistStateStorage?: PersistStateStorage;
   /** Render rounded corners for selection ranges, default is true. */
   roundedSelection?: boolean;
   /** Highlight matching brackets near the caret, default is true. */
@@ -17,9 +28,11 @@ interface EditorOptions<LAnnotation> {
    * Default is `"default"` (both quotes and brackets).
    */
   autoSurround?: AutoSurround;
+  /** Per-language comment tokens used by the comment commands. */
+  languageCommentConfig?: LanguageConfigMap;
   /**
-   * Show a floating selection action popover anchored to the active selection,
-   * default is disabled.
+   * Show a floating selection action popover after a user-created selection,
+   * default is disabled. Programmatic selection updates do not open it.
    */
   enabledSelectionAction?: boolean;
   /**
@@ -28,33 +41,42 @@ interface EditorOptions<LAnnotation> {
    * see https://www.electronjs.org/docs/latest/api/clipboard
    */
   clipboard?: {
-    readText: () => Promise<string> | string;
+    readText: (type?: string) => Promise<string> | string;
   };
   /** Render the selection action widget element. */
   renderSelectionAction?: (context: SelectionActionContext<LAnnotation>) => HTMLElement;
   /** Callback when the editor is attached to a file. */
   onAttach?: (editor: Editor<LAnnotation>, fileInstance: DiffsEditableComponent<LAnnotation>) => void;
   /** Callback when the editor document changes. */
-  onChange?: (file: FileContents, lineAnnotations?: DiffLineAnnotation<LAnnotation>[]) => void;
+  onChange?: (file: FileContents, lineAnnotations?: LineAnnotation<LAnnotation>[] | DiffLineAnnotation<LAnnotation>[]) => void;
   /** Callback when the editor gains focus. */
   onFocus?: () => void;
   /** Callback when the editor loses focus. */
   onBlur?: () => void;
   __debug?: boolean;
 }
-interface EditorState<LAnnotation> {
-  file: FileContents;
-  lineAnnotations?: DiffLineAnnotation<LAnnotation>[];
-  selections?: EditorSelection[];
-  renderRange?: RenderRange;
+interface EditorFocusOptions extends FocusOptions {
+  /** One-based document line number or first editable line with a visible top. */
+  lineNumber?: number | 'first-visible';
+  /** Zero-based character offset for a numeric line. Defaults to 0. */
+  character?: number;
+  /** Non-negative CSS pixels below the viewport or sticky header. */
+  offset?: number;
 }
 declare class Editor<LAnnotation> implements DiffsEditor<LAnnotation> {
   #private;
   constructor(options?: EditorOptions<LAnnotation>);
   setOptions(options: EditorOptions<LAnnotation>): void;
-  edit(fileInstance: DiffsEditableComponent<LAnnotation>): () => void;
+  edit<T extends DiffsEditableComponent<LAnnotation>>(fileInstance: EditableInstance<T>): () => void;
   /**
-   * Apply edits to current attached file.
+   * Apply edits to current attached file. Every edit joins the undo timeline:
+   * a programmatic edit must leave the document and its history exactly as
+   * the same edit typed by the user would (history equivalence — see
+   * TextDocument.applyResolvedEdits), so it is undoable like any other edit.
+   *
+   * @param updateHistory Whether to record caller selection snapshots for
+   * exact undo/redo restoration. Defaults to true. When false, live selections
+   * are remapped during replay and the text edit still joins the undo timeline.
    */
   applyEdits(edits: TextEdit[], updateHistory?: boolean): void;
   /** Whether there is an edit to undo. */
@@ -65,23 +87,29 @@ declare class Editor<LAnnotation> implements DiffsEditor<LAnnotation> {
   undo(): void;
   /** Redo the last undone edit. Does nothing when there is nothing to redo. */
   redo(): void;
-  getState(): EditorState<LAnnotation>;
+  getFile(): FileContents | undefined;
+  getText(): string;
+  getState(): EditorState;
   setState({
-    file,
-    lineAnnotations,
-    renderRange,
-    selections
-  }: EditorState<LAnnotation>): void;
-  setSelections(selections: DiffsEditorSelection[]): void;
+    selections,
+    view
+  }: EditorState): void;
+  setSelections(selections: (Range & {
+    direction: 'none' | 'backward' | 'forward';
+  })[]): void;
   setMarkers(markers: Marker[]): void;
-  focus(options?: FocusOptions): void;
+  focus(options?: EditorFocusOptions): void;
   blur(): void;
   cleanUp(recycle?: boolean): void;
+  /** @internal Capture outgoing state and substitute cached text before render. */
+  __prepareFile(file: FileContents): FileContents;
   /** @internal */
   __postponeBgTokenizeToNextFrame(): void;
   /** @internal */
+  __captureFocusForDOMReplacement(): void;
+  /** @internal */
   __syncRenderView: DiffsEditor<LAnnotation>['__syncRenderView'];
 }
 //#endregion
-export { Editor, EditorOptions, EditorState };
+export { Editor, EditorFocusOptions, EditorOptions };
 //# sourceMappingURL=editor.d.ts.map

package/dist/editor/editor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"editor.d.ts","names":[],"sources":["../../src/editor/editor.ts"],"mappings":";;;;;;;UA4GiB,aAAA;;EAEf,iBAAA;EAF4B;EAI5B,gBAAA;EAOe;EALf,aAAA;EAqBkC;;;;EAhBlC,YAAA,GAAe,YAAA;EAqBwB;;;;EAhBvC,sBAAA;EAqBsC;;;;;EAftC,SAAA;IACE,QAAA,QAAgB,OAAA;EAAA;EAPlB;EAUA,qBAAA,IACE,OAAA,EAAS,sBAAA,CAAuB,WAAA,MAC7B,WAAA;EALH;EAOF,QAAA,IACE,MAAA,EAAQ,MAAA,CAAO,WAAA,GACf,YAAA,EAAc,sBAAA,CAAuB,WAAA;EANvC;EASA,QAAA,IACE,IAAA,EAAM,YAAA,EACN,eAAA,GAAkB,kBAAA,CAAmB,WAAA;EAVL;EAalC,OAAA;EAZK;EAcL,MAAA;EAEA,OAAA;AAAA;AAAA,UAGe,WAAA;EACf,IAAA,EAAM,YAAA;EACN,eAAA,GAAkB,kBAAA,CAAmB,WAAA;EACrC,UAAA,GAAa,eAAA;EACb,WAAA,GAAc,WAAA;AAAA;AAAA,cAUH,MAAA,yBAA+B,WAAA,CAAY,WAAA;EAAA;EAsHtD,WAAA,CAAY,OAAA,GAAS,aAAA,CAAc,WAAA;EAInC,UAAA,CAAW,OAAA,EAAS,aAAA,CAAc,WAAA;EAOlC,IAAA,CAAK,YAAA,EAAc,sBAAA,CAAuB,WAAA;EApJ1C;;;EAuLA,UAAA,CAAW,KAAA,EAAO,QAAA,IAAY,aAAA;EAlLf;EAAA,IA+PX,OAAA;EA/PsB;EAAA,IAoQtB,OAAA;EAlQiC;EAuQrC,IAAA;EAtQa;EA2Qb,IAAA;EAIA,QAAA,IAAY,WAAA,CAAY,WAAA;EAaxB,QAAA;IACE,IAAA;IACA,eAAA;IACA,WAAA;IACA;EAAA,GACC,WAAA,CAAY,WAAA;EAWf,aAAA,CAAc,UAAA,EAAY,oBAAA;EAoB1B,UAAA,CAAW,OAAA,EAAS,MAAA;EA6BpB,KAAA,CAAM,OAAA,GAAU,YAAA;EAchB,IAAA;EAIA,OAAA,CAAQ,OAAA;EAhX6B;EAqbrC,+BAAA;EApba;EA+bb,gBAAA,EAAkB,WAAA,CAAY,WAAA;AAAA"}
+{"version":3,"file":"editor.d.ts","names":[],"sources":["../../src/editor/editor.ts"],"mappings":";;;;;;;;UAyLiB,aAAA;;EAEf,iBAAA;EAF4B;;;;EAO5B,YAAA;EA4B+B;;;;EAvB/B,mBAAA,GAAsB,mBAAA;EA+BZ;EA7BV,gBAAA;EA8BgB;EA5BhB,aAAA;EAkCqB;;;;EA7BrB,YAAA,GAAe,YAAA;EA8BS;EA5BxB,qBAAA,GAAwB,iBAAA;EArBxB;;;;EA0BA,sBAAA;EAZA;;;;;EAkBA,SAAA;IACE,QAAA,GAAW,IAAA,cAAkB,OAAA;EAAA;EAAlB;EAGb,qBAAA,IACE,OAAA,EAAS,sBAAA,CAAuB,WAAA,MAC7B,WAAA;EAFL;EAIA,QAAA,IACE,MAAA,EAAQ,MAAA,CAAO,WAAA,GACf,YAAA,EAAc,sBAAA,CAAuB,WAAA;EALL;EAQlC,QAAA,IACE,IAAA,EAAM,YAAA,EACN,eAAA,GACI,cAAA,CAAe,WAAA,MACf,kBAAA,CAAmB,WAAA;EAXpB;EAcL,OAAA;EAXU;EAaV,MAAA;EAEA,OAAA;AAAA;AAAA,UAGe,kBAAA,SAA2B,YAAY;EAjBpD;EAmBF,UAAA;EAfQ;EAiBR,SAAA;EAfM;EAiBN,MAAA;AAAA;AAAA,cAmBW,MAAA,yBAA+B,WAAA,CAAY,WAAA;EAAA;EAkJtD,WAAA,CAAY,OAAA,GAAS,aAAA,CAAc,WAAA;EAInC,UAAA,CAAW,OAAA,EAAS,aAAA,CAAc,WAAA;EAkClC,IAAA,WAAe,sBAAA,CAAuB,WAAA,GACpC,YAAA,EAAc,gBAAA,CAAiB,CAAA;EArN1B;AAAA;AAGT;;;;;;;;EAmPE,UAAA,CAAW,KAAA,EAAO,QAAA,IAAY,aAAA;EA7OxB;EAAA,IAgTF,OAAA;EA7Ra;EAAA,IAkSb,OAAA;EAlSkD;EAuStD,IAAA;EArJqB;EA0JrB,IAAA;EAIA,OAAA,IAAW,YAAA;EAcX,OAAA;EAIA,QAAA,IAAY,WAAA;EAaZ,QAAA;IAAW,UAAA;IAAY;EAAA,GAAQ,WAAA;EAgB/B,aAAA,CACE,UAAA,GAAa,KAAA;IAAU,SAAA;EAAA;EAoCzB,UAAA,CAAW,OAAA,EAAS,MAAA;EA6BpB,KAAA,CAAM,OAAA,GAAU,kBAAA;EAmChB,IAAA;EAOA,OAAA,CAAQ,OAAA;EA3GO;EA8Lf,aAAA,CAAc,IAAA,EAAM,YAAA,GAAe,YAAA;EA7HnB;EAyJhB,+BAAA;EA5BmC;EAuCnC,+BAAA;EAekB;EAAlB,gBAAA,EAAkB,WAAA,CAAY,WAAA;AAAA"}