@ones-editor/editor 1.0.2 → 1.0.3

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.
@@ -190,7 +190,13 @@ export interface InsertBlockOptions {
190
190
  noFocus?: boolean;
191
191
  }
192
192
  export type UpdateBlockOptions = InsertBlockOptions;
193
- export interface OnesEditorDoc {
193
+ export interface OnesEditorDocServer {
194
+ getServerMeta?: () => OnesEditorDocServerMeta;
195
+ buildResourceUrl: (resourceId: string, options?: BuildResourceUrlOptions) => string;
196
+ getVersionHelper?: () => OnesEditorDocVersionHelper | undefined;
197
+ getRemoteUsers: () => OnesEditorRemoteUsers;
198
+ }
199
+ export interface OnesEditorDoc extends OnesEditorDocServer {
194
200
  registerCallback: (callbacks: OnesEditorDocCallbacks) => void;
195
201
  unregisterCallback: (callbacks: OnesEditorDocCallbacks) => void;
196
202
  toJSON: () => DocObject;
@@ -209,15 +215,11 @@ export interface OnesEditorDoc {
209
215
  addResources: (resourceIds: string[]) => Promise<string[]>;
210
216
  patchSyncResources: (resourceIds: string[]) => Promise<string[]>;
211
217
  uploadResource: (file: File, options?: UploadResourceOptions) => Promise<UploadResourceResult>;
212
- buildResourceUrl: (resourceId: string, options?: BuildResourceUrlOptions) => string;
213
218
  request: <T = unknown>(url: string, options?: unknown) => Promise<T>;
214
219
  broadcastMessage: (data: unknown) => void;
215
220
  destroy: () => void;
216
221
  getUser: () => OnesEditorUser;
217
- getRemoteUsers: () => OnesEditorRemoteUsers;
218
222
  recognizeLink?: (link: string) => Promise<RecognizeLinkResult>;
219
- getVersionHelper?: () => OnesEditorDocVersionHelper | undefined;
220
- getServerMeta?: () => OnesEditorDocServerMeta;
221
223
  beginBatchUpdate: () => number;
222
224
  endBatchUpdate: () => number;
223
225
  }
@@ -3,3 +3,4 @@ import { RemoteCarets, RemoteCaretsDecorator } from './remote-carets';
3
3
  export { ShareDBDoc, RemoteCarets, RemoteCaretsDecorator };
4
4
  export * from './doc/comments';
5
5
  export * from './types';
6
+ export * from './versions';
@@ -0,0 +1,2 @@
1
+ import ShareDBServer from './sharedb-server';
2
+ export { ShareDBServer };
@@ -0,0 +1,29 @@
1
+ import { BuildResourceUrlOptions, DocObject, DocVersion, EventCallbacks, OnesEditorDocHistoryData, OnesEditorDocServer, OnesEditorDocServerMeta, OnesEditorDocVersionExtra, OnesEditorDocVersionHelper, OnesEditorHistoryDataParseHandler, RemoteUsers } from '../../../../@ones-editor/core';
2
+ import { ShareDBDocCallbacks, ShareDBDocOptions } from '../types';
3
+ import ShareDBSimpleClient from './simple-client';
4
+ export default class ShareDBServer extends EventCallbacks<ShareDBDocCallbacks> implements OnesEditorDocServer, OnesEditorDocVersionHelper {
5
+ private options;
6
+ remoteUsers: RemoteUsers;
7
+ client: ShareDBSimpleClient;
8
+ constructor(options: ShareDBDocOptions);
9
+ destroy(): void;
10
+ buildResourceUrl(resourceId: string, options?: BuildResourceUrlOptions): string;
11
+ getRemoteUsers(): RemoteUsers;
12
+ getVersionHelper(): OnesEditorDocVersionHelper;
13
+ getVersions(): Promise<DocVersion[]>;
14
+ getVersion(ver: number): Promise<DocObject>;
15
+ getLatestVersion(): Promise<DocObject>;
16
+ getHistoryData(version: number, from?: number | undefined): Promise<{
17
+ doc: DocObject;
18
+ historyData: OnesEditorDocHistoryData[];
19
+ }>;
20
+ getVersionData(version: number, from?: number): Promise<{
21
+ doc: DocObject;
22
+ versionData: unknown;
23
+ }>;
24
+ updateVersionExtra(version: number, tagId: string, extra: OnesEditorDocVersionExtra): Promise<void>;
25
+ revertVersion(ver: number): Promise<void>;
26
+ createVersion(tag: string, publish: boolean): Promise<DocVersion>;
27
+ parseHistoryData(historyData: OnesEditorDocHistoryData, handler: OnesEditorHistoryDataParseHandler): void;
28
+ getServerMeta(): OnesEditorDocServerMeta;
29
+ }
@@ -0,0 +1,25 @@
1
+ import { BuildResourceUrlOptions, DocVersion, OnesEditorDocVersionExtra } from '../../../../@ones-editor/core';
2
+ import { AxiosResponse } from 'axios';
3
+ import { AuthMessage, EditorDoc, EditorOp } from '../types';
4
+ export default class ShareDBSimpleClient {
5
+ private serverUrl;
6
+ auth: AuthMessage;
7
+ clientId: string;
8
+ constructor(auth: AuthMessage, serverUrl: string);
9
+ editorServer(): string;
10
+ apiServer(): string;
11
+ getBaseURL(): string;
12
+ getBase64BaseURL(): string;
13
+ request<T = unknown>(url: string, opt?: any): Promise<AxiosResponse<any, T>>;
14
+ getVersions(): Promise<DocVersion[]>;
15
+ getVersion(ver: number): Promise<EditorDoc>;
16
+ getLatestVersion(): Promise<EditorDoc>;
17
+ getVersionOps(version: number, from?: number): Promise<{
18
+ doc: EditorDoc;
19
+ ops: EditorOp[];
20
+ }>;
21
+ updateVersionExtra(version: number, tagId: string, extra: OnesEditorDocVersionExtra): Promise<void>;
22
+ revertVersion(ver: number): Promise<void>;
23
+ createVersion(tag: string, publish: boolean): Promise<any>;
24
+ buildResourceUrl(resourceId: string, options?: BuildResourceUrlOptions): string;
25
+ }