@ones-editor/editor 4.0.0 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,12 @@
1
+ import type { OnesEditorVersionsProvider } from './types';
2
+ import type { DocObject, OnesEditor, OnesEditorBlockRenderer, OnesEditorDocHistoryData, OnesEditorDocServer, OnesEditorDocVersionHelper } from '../../../@ones-editor/core';
3
+ export interface CreateOnesEditorHistoryDiffOptions {
4
+ server: OnesEditorDocServer;
5
+ provider: OnesEditorVersionsProvider;
6
+ doc: DocObject;
7
+ historyData: OnesEditorDocHistoryData[];
8
+ versionHelper: Pick<OnesEditorDocVersionHelper, 'parseHistoryData'>;
9
+ editorOptions?: unknown;
10
+ textRenders?: OnesEditorBlockRenderer[];
11
+ }
12
+ export declare function createOnesEditorHistoryDiff(parent: HTMLElement, options: CreateOnesEditorHistoryDiffOptions): Promise<OnesEditor>;
@@ -1,4 +1,4 @@
1
- import { DocBlock, DocBlockDelta, DocBlockText, DocBlockTextActions, DocObject, EventCallbacks, OnesEditorDoc, OnesEditorDocCallbacks, OnesEditorUser, UploadResourceResult, OnesEditorDocServerMeta, OnesEditorDocServer } from '../../../../@ones-editor/core';
1
+ import { BuildResourceUrlOptions, DocBlock, DocBlockDelta, DocBlockText, DocBlockTextActions, DocObject, EventCallbacks, OnesEditorDoc, OnesEditorDocCallbacks, OnesEditorUser, UploadResourceResult, OnesEditorDocServerMeta, OnesEditorDocServer } from '../../../../@ones-editor/core';
2
2
  import { HistoryUser } from '../types';
3
3
  export default class HistoryDoc extends EventCallbacks<OnesEditorDocCallbacks> implements OnesEditorDoc {
4
4
  private server;
@@ -21,7 +21,7 @@ export default class HistoryDoc extends EventCallbacks<OnesEditorDocCallbacks> i
21
21
  uploadResource(): Promise<UploadResourceResult>;
22
22
  addResources(resourceIds: string[]): Promise<string[]>;
23
23
  getServerMeta(): OnesEditorDocServerMeta;
24
- buildResourceUrl(src: string): string;
24
+ buildResourceUrl(src: string, options?: BuildResourceUrlOptions): string;
25
25
  request<T>(): Promise<T>;
26
26
  broadcastMessage(): void;
27
27
  getUser(): OnesEditorUser;
@@ -1,5 +1,7 @@
1
1
  import './index.scss';
2
2
  import './locale';
3
3
  export { OnesEditorVersionsDialog } from './version-dialog';
4
+ export { createOnesEditorHistoryDiff } from './history-diff';
4
5
  export { HISTORY_TOOLTIP_IDENTIFIER } from './constant';
5
6
  export * from './types';
7
+ export type { CreateOnesEditorHistoryDiffOptions } from './history-diff';
@@ -18,6 +18,7 @@ export interface VersionDialogOptions {
18
18
  onVersionsLoaded?: (sender: unknown, versions: DocVersion[]) => void;
19
19
  decorateItem?: (item: HTMLElement, ver: DocVersion) => void;
20
20
  onCopyVersionLink?: (ver: DocVersion) => void;
21
+ forceRequestVersionAsLatest?: boolean;
21
22
  }
22
23
  export type VersionNum = number | string;
23
24
  export interface PlayOptions {
@@ -18,6 +18,7 @@ export declare class OnesEditorVersionsDialog implements OnesEditorCustom {
18
18
  private handleSelectVersion;
19
19
  private handleCompareWithVersion;
20
20
  private handleHelp;
21
+ private createVersionFromNum;
21
22
  private viewVersion;
22
23
  private onMemoChanged;
23
24
  private renderContent;
@@ -1,3 +1,3 @@
1
1
  import type { OnesEditorDocHistoryData, OnesEditorDocVersionHelper } from '../../../../@ones-editor/core';
2
2
  import HistoryDoc from '../history-doc';
3
- export declare function playHistoryData(doc: HistoryDoc, versionHelper: OnesEditorDocVersionHelper, historyData: OnesEditorDocHistoryData[]): Promise<void>;
3
+ export declare function playHistoryData(doc: HistoryDoc, versionHelper: Pick<OnesEditorDocVersionHelper, 'parseHistoryData'>, historyData: OnesEditorDocHistoryData[]): Promise<void>;
@@ -0,0 +1,12 @@
1
+ import type { CreateOnesEditorOptions } from './types';
2
+ import type { EditorDoc } from '../@ones-editor/sharedb-doc';
3
+ import type { DocObject, OnesEditor, OnesEditorBlockRenderer, OnesEditorDocServer, OnesEditorDocVersionHelper } from '../@ones-editor/core';
4
+ export interface CreateDocHistoryDiffEditorOptions {
5
+ data: string | EditorDoc | DocObject;
6
+ ops?: unknown[];
7
+ editorOptions: CreateOnesEditorOptions;
8
+ server?: OnesEditorDocServer;
9
+ versionHelper?: Pick<OnesEditorDocVersionHelper, 'parseHistoryData'>;
10
+ textRenders?: OnesEditorBlockRenderer[];
11
+ }
12
+ export declare function createDocHistoryDiffEditor(parent: HTMLElement, options: CreateDocHistoryDiffEditorOptions): Promise<OnesEditor>;
package/dist/index.d.ts CHANGED
@@ -49,6 +49,8 @@ export * from './helper';
49
49
  export { OnesEditorComments, OnesEditorCommentsRender } from '../@ones-editor/comments';
50
50
  export * from '../@ones-editor/cke-html';
51
51
  export { type DocListBlock } from '../@ones-editor/list-block';
52
+ export { createDocHistoryDiffEditor } from './history-diff';
53
+ export type { CreateDocHistoryDiffEditorOptions } from './history-diff';
52
54
  export declare function getDefaultOnesEditorOptions(options: CreateOnesEditorOptions): {
53
55
  id: string | undefined;
54
56
  scrollContainer: HTMLElement | undefined;
@@ -61,7 +63,7 @@ export declare function getDefaultOnesEditorOptions(options: CreateOnesEditorOpt
61
63
  embeds: import("@ones-editor/core").Embed[];
62
64
  boxes: import("@ones-editor/core").Box[];
63
65
  commandProviders: (import("@ones-editor/core").OnesEditorCommandProvider | TableBlockCommandProvider)[];
64
- decorators: (RemoteCaretsDecorator | CodeTextDecorator)[];
66
+ decorators: (CodeTextDecorator | RemoteCaretsDecorator)[];
65
67
  insertions: import("@ones-editor/core").Insertion[];
66
68
  blockHooks: (import("@ones-editor/core").OnesEditorBlockHook | BlockExclusiveHook)[];
67
69
  textRenders: OnesEditorBlockRenderer[];