@datalking/begonia-browser-sdk 0.0.0-stage → 0.1.1
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.
- package/LICENSE.md +661 -0
- package/README.md +8 -2
- package/dist/browser-advanced-ooxml-command-types.d.ts +3 -0
- package/dist/browser-advanced-ooxml-edit-plan-shape.d.ts +3 -0
- package/dist/browser-advanced-ooxml-inspector-controller.d.ts +2 -0
- package/dist/browser-advanced-ooxml-inspector-formats.d.ts +71 -0
- package/dist/browser-advanced-ooxml-inspector-snapshot.d.ts +3 -0
- package/dist/browser-advanced-ooxml-inspector-types.d.ts +56 -0
- package/dist/browser-advanced-ooxml-nodeview-events.d.ts +168 -0
- package/dist/browser-advanced-ooxml-subtree-chart.d.ts +13 -0
- package/dist/browser-advanced-ooxml-subtree-editor.d.ts +38 -0
- package/dist/browser-advanced-ooxml-subtree-math-insertions.d.ts +2 -0
- package/dist/browser-advanced-ooxml-subtree-math-serialize.d.ts +3 -0
- package/dist/browser-advanced-ooxml-subtree-math-shared.d.ts +16 -0
- package/dist/browser-advanced-ooxml-subtree-math.d.ts +7 -0
- package/dist/browser-advanced-ooxml-subtree-shape-insertions.d.ts +2 -0
- package/dist/browser-advanced-ooxml-subtree-shape-parse.d.ts +3 -0
- package/dist/browser-advanced-ooxml-subtree-shape-sections.d.ts +16 -0
- package/dist/browser-advanced-ooxml-subtree-shape-types.d.ts +12 -0
- package/dist/browser-advanced-ooxml-subtree-shape.d.ts +4 -0
- package/dist/browser-advanced-ooxml-surface-feature-helpers.d.ts +3 -0
- package/dist/browser-advanced-ooxml-surface-feature.d.ts +4 -0
- package/dist/browser-command-controller.d.ts +2 -0
- package/dist/browser-command-types.d.ts +263 -0
- package/dist/browser-comment-target-selection.d.ts +22 -0
- package/dist/browser-document-api-selection.d.ts +26 -0
- package/dist/browser-editor-active-comment-selection.d.ts +21 -0
- package/dist/browser-editor-active-comment.d.ts +16 -0
- package/dist/browser-editor-active-revision.d.ts +19 -0
- package/dist/browser-editor-advanced-ooxml-chart.d.ts +22 -0
- package/dist/browser-editor-advanced-ooxml-core.d.ts +25 -0
- package/dist/browser-editor-advanced-ooxml-math.d.ts +10 -0
- package/dist/browser-editor-advanced-ooxml-nodeview-bridge.d.ts +5 -0
- package/dist/browser-editor-advanced-ooxml-shape.d.ts +25 -0
- package/dist/browser-editor-advanced-ooxml.d.ts +4 -0
- package/dist/browser-editor-backend-access.d.ts +9 -0
- package/dist/browser-editor-backend-adapter-v1.d.ts +4 -0
- package/dist/browser-editor-backend-adapter.d.ts +17 -0
- package/dist/browser-editor-collaboration-state-types.d.ts +15 -0
- package/dist/browser-editor-comment-navigation.d.ts +16 -0
- package/dist/browser-editor-comment-replay-target.d.ts +23 -0
- package/dist/browser-editor-comment-target-selection-v1.d.ts +7 -0
- package/dist/browser-editor-comments-controller.d.ts +4 -0
- package/dist/browser-editor-comments-types.d.ts +47 -0
- package/dist/browser-editor-comments-write-state.d.ts +11 -0
- package/dist/browser-editor-contracts-v1.d.ts +47 -0
- package/dist/browser-editor-contracts.d.ts +59 -0
- package/dist/browser-editor-create.d.ts +7 -0
- package/dist/browser-editor-domain-types.d.ts +87 -0
- package/dist/browser-editor-host.d.ts +14 -0
- package/dist/browser-editor-inline-format-actions.d.ts +19 -0
- package/dist/browser-editor-inline-format-state.d.ts +7 -0
- package/dist/browser-editor-mount-controller.d.ts +23 -0
- package/dist/browser-editor-mount.d.ts +8 -0
- package/dist/browser-editor-node-selection-rebase.d.ts +21 -0
- package/dist/browser-editor-node-selection-target-types.d.ts +9 -0
- package/dist/browser-editor-point-context.d.ts +27 -0
- package/dist/browser-editor-point-position.d.ts +3 -0
- package/dist/browser-editor-point-types.d.ts +16 -0
- package/dist/browser-editor-preserved-range-shared.d.ts +31 -0
- package/dist/browser-editor-preserved-range-state.d.ts +39 -0
- package/dist/browser-editor-preserved-range-target-selection.d.ts +29 -0
- package/dist/browser-editor-projected-selection-change-ranges.d.ts +14 -0
- package/dist/browser-editor-projected-selection-review-rebase.d.ts +26 -0
- package/dist/browser-editor-projected-selection-review-state.d.ts +20 -0
- package/dist/browser-editor-projected-selection-review-transitions.d.ts +33 -0
- package/dist/browser-editor-projection-snapshot.d.ts +41 -0
- package/dist/browser-editor-range-selection.d.ts +10 -0
- package/dist/browser-editor-review-comment-selection.d.ts +12 -0
- package/dist/browser-editor-review-projection.d.ts +16 -0
- package/dist/browser-editor-review-selection-state.d.ts +39 -0
- package/dist/browser-editor-runtime-v1.d.ts +16 -0
- package/dist/browser-editor-selection-capture-create.d.ts +8 -0
- package/dist/browser-editor-selection-capture.d.ts +17 -0
- package/dist/browser-editor-selection-geometry.d.ts +35 -0
- package/dist/browser-editor-selection-handle.d.ts +6 -0
- package/dist/browser-editor-selection-orientation.d.ts +14 -0
- package/dist/browser-editor-selection-rebase-targets-surface.d.ts +34 -0
- package/dist/browser-editor-selection-rebase-targets-types.d.ts +39 -0
- package/dist/browser-editor-selection-rebase-targets.d.ts +37 -0
- package/dist/browser-editor-selection-rebase.d.ts +29 -0
- package/dist/browser-editor-selection-restore.d.ts +23 -0
- package/dist/browser-editor-selection-snapshot.d.ts +35 -0
- package/dist/browser-editor-selection-target-from-block-path.d.ts +3 -0
- package/dist/browser-editor-surface-projection-mode.d.ts +10 -0
- package/dist/browser-editor-text-target-selection.d.ts +29 -0
- package/dist/browser-editor-track-change-navigation.d.ts +8 -0
- package/dist/browser-editor-track-change-types.d.ts +69 -0
- package/dist/browser-editor-track-changes-controller.d.ts +6 -0
- package/dist/browser-editor-types-collaboration.d.ts +57 -0
- package/dist/browser-editor-types-controller.d.ts +139 -0
- package/dist/browser-editor-types-shared.d.ts +205 -0
- package/dist/browser-editor-types-state.d.ts +45 -0
- package/dist/browser-editor-types.d.ts +7 -0
- package/dist/browser-editor-ui-controller.d.ts +4 -0
- package/dist/browser-editor-ui-source.d.ts +5 -0
- package/dist/browser-editor-ui-types.d.ts +73 -0
- package/dist/browser-editor-ui.d.ts +2 -0
- package/dist/browser-editor-view-intent.d.ts +35 -0
- package/dist/browser-editor-viewport/browser-editor-viewport-bounds.d.ts +41 -0
- package/dist/browser-editor-viewport/browser-editor-viewport-normalize.d.ts +25 -0
- package/dist/browser-editor-viewport-context-types.d.ts +19 -0
- package/dist/browser-editor-viewport-geometry.d.ts +45 -0
- package/dist/browser-editor-viewport-helpers.d.ts +2 -0
- package/dist/browser-editor-viewport-scroll-into-view.d.ts +30 -0
- package/dist/browser-editor-viewport-session-navigation.d.ts +4 -0
- package/dist/browser-editor-viewport-session-patch.d.ts +3 -0
- package/dist/browser-editor-viewport-session-state-types.d.ts +23 -0
- package/dist/browser-editor-viewport-session-state.d.ts +4 -0
- package/dist/browser-editor-viewport-types.d.ts +21 -0
- package/dist/browser-headless-toolbar-types.d.ts +92 -0
- package/dist/browser-headless-toolbar.d.ts +3 -0
- package/dist/browser-paginated-preview-binding-projection.d.ts +9 -0
- package/dist/browser-paginated-preview-controller-state.d.ts +84 -0
- package/dist/browser-paginated-preview-controller.d.ts +16 -0
- package/dist/browser-paginated-preview-editor-binding.d.ts +28 -0
- package/dist/browser-paginated-preview-helpers.d.ts +35 -0
- package/dist/browser-paginated-preview-lifecycle-reset.d.ts +18 -0
- package/dist/browser-paginated-preview-mode-state.d.ts +9 -0
- package/dist/browser-paginated-preview-navigation-anchor.d.ts +4 -0
- package/dist/browser-paginated-preview-pins.d.ts +17 -0
- package/dist/browser-paginated-preview-position-hit.d.ts +31 -0
- package/dist/browser-paginated-preview-reset-plan.d.ts +31 -0
- package/dist/browser-paginated-preview-selection-actions.d.ts +13 -0
- package/dist/browser-paginated-preview-selection-v1.d.ts +1 -0
- package/dist/browser-paginated-preview-selection.d.ts +20 -0
- package/dist/browser-paginated-preview-session-state.d.ts +51 -0
- package/dist/browser-paginated-preview-text-selection.d.ts +21 -0
- package/dist/browser-paginated-preview-ui-controller.d.ts +19 -0
- package/dist/browser-paginated-preview-view-model.d.ts +35 -0
- package/dist/browser-review-comment-types.d.ts +33 -0
- package/dist/browser-review-revision-types.d.ts +41 -0
- package/dist/browser-slash-menu-controller.d.ts +2 -0
- package/dist/browser-theme.d.ts +26 -0
- package/dist/command.js +5 -0
- package/dist/editor.d.ts +36 -0
- package/dist/editor.js +4 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.js +5 -0
- package/dist/ooxml.d.ts +17 -0
- package/dist/ooxml.js +4 -0
- package/dist/paginated-preview-selection-table/preview-selection-table-hit.d.ts +7 -0
- package/dist/paginated-preview-selection-table/preview-selection-table-resolve.d.ts +76 -0
- package/dist/paginated-preview-selection-v1/preview-selection-v1-handle.d.ts +7 -0
- package/dist/paginated-preview-selection-v1/preview-selection-v1-resolve.d.ts +33 -0
- package/dist/preview.d.ts +7 -0
- package/dist/preview.js +1 -0
- package/dist/theme.js +1 -0
- package/dist/v1.d.ts +40 -0
- package/dist/v1.js +9 -0
- package/package.json +63 -4
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
type DocumentSurface = any;
|
|
2
|
+
type DocumentSurfaceOptions = any;
|
|
3
|
+
type ProseMirrorNode = any;
|
|
4
|
+
|
|
5
|
+
import type { BegoniaAsyncResult } from '@datalking/begonia-result';
|
|
6
|
+
|
|
7
|
+
export type BrowserEditorCollaborationConnectionState = 'connected' | 'connecting' | 'disconnected' | 'error';
|
|
8
|
+
export interface BrowserEditorCollaborationSessionSnapshot {
|
|
9
|
+
collaborative: boolean;
|
|
10
|
+
providerName: string | null;
|
|
11
|
+
roomId: string | null;
|
|
12
|
+
status: BrowserEditorCollaborationConnectionState;
|
|
13
|
+
connected: boolean | null;
|
|
14
|
+
synced: boolean | null;
|
|
15
|
+
awarenessClientCount: number | null;
|
|
16
|
+
message: string | null;
|
|
17
|
+
}
|
|
18
|
+
export interface BrowserEditorCollaborationState extends BrowserEditorCollaborationSessionSnapshot {
|
|
19
|
+
mode: 'none' | 'binding' | 'session';
|
|
20
|
+
reconfigurable: boolean;
|
|
21
|
+
}
|
|
22
|
+
export interface BrowserEditorCollaborationCapture {
|
|
23
|
+
document: ProseMirrorNode;
|
|
24
|
+
documentJson: ReturnType<ProseMirrorNode['toJSON']>;
|
|
25
|
+
update: Uint8Array;
|
|
26
|
+
awareness: Uint8Array | null;
|
|
27
|
+
snapshot: BrowserEditorCollaborationSessionSnapshot;
|
|
28
|
+
}
|
|
29
|
+
export interface BrowserEditorCollaborationSessionLike {
|
|
30
|
+
readonly binding: NonNullable<DocumentSurfaceOptions['collaborative']>;
|
|
31
|
+
getSnapshot(): BrowserEditorCollaborationSessionSnapshot;
|
|
32
|
+
subscribe?(listener: (snapshot: BrowserEditorCollaborationSessionSnapshot) => void): () => void;
|
|
33
|
+
connect?(): Promise<BegoniaAsyncResult<BrowserEditorCollaborationSessionSnapshot> | BrowserEditorCollaborationSessionSnapshot> | BegoniaAsyncResult<BrowserEditorCollaborationSessionSnapshot> | BrowserEditorCollaborationSessionSnapshot;
|
|
34
|
+
disconnect?(): Promise<BegoniaAsyncResult<BrowserEditorCollaborationSessionSnapshot> | BrowserEditorCollaborationSessionSnapshot> | BegoniaAsyncResult<BrowserEditorCollaborationSessionSnapshot> | BrowserEditorCollaborationSessionSnapshot;
|
|
35
|
+
destroy?(): Promise<BegoniaAsyncResult<{
|
|
36
|
+
destroyed: true;
|
|
37
|
+
}> | {
|
|
38
|
+
destroyed: true;
|
|
39
|
+
}> | BegoniaAsyncResult<{
|
|
40
|
+
destroyed: true;
|
|
41
|
+
}> | {
|
|
42
|
+
destroyed: true;
|
|
43
|
+
};
|
|
44
|
+
encodeSnapshot?(): Promise<BegoniaAsyncResult<BrowserEditorCollaborationCapture> | BrowserEditorCollaborationCapture> | BegoniaAsyncResult<BrowserEditorCollaborationCapture> | BrowserEditorCollaborationCapture;
|
|
45
|
+
}
|
|
46
|
+
export interface BrowserEditorSurfaceFactoryRequest {
|
|
47
|
+
currentSurface: DocumentSurface;
|
|
48
|
+
collaborative?: DocumentSurfaceOptions['collaborative'];
|
|
49
|
+
element?: HTMLElement;
|
|
50
|
+
initialContent: ProseMirrorNode;
|
|
51
|
+
documentStory: DocumentSurface['documentStory'];
|
|
52
|
+
schema: DocumentSurface['schema'];
|
|
53
|
+
participant: DocumentSurface['participant'];
|
|
54
|
+
trackingEnabled: boolean;
|
|
55
|
+
editable: boolean;
|
|
56
|
+
}
|
|
57
|
+
export type BrowserEditorSurfaceFactory = (request: BrowserEditorSurfaceFactoryRequest) => DocumentSurface;
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
type DocumentApi = any;
|
|
2
|
+
type DocumentTemplatesAdapter = any;
|
|
3
|
+
type DocumentService = any;
|
|
4
|
+
type DocumentSurface = any;
|
|
5
|
+
type DocumentSurfaceOptions = any;
|
|
6
|
+
type SurfaceFeatureDefinition = any;
|
|
7
|
+
import type { SelectionCurrentInput } from '@datalking/begonia-document-api/core';
|
|
8
|
+
|
|
9
|
+
import type { EditorSessionController, EditorSessionHost } from '@datalking/begonia-editor-contracts';
|
|
10
|
+
import type { DocumentPermissionActor, DocumentPermissionResolver } from '@datalking/begonia-document-api/review';
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
import type { BegoniaAsyncResult } from '@datalking/begonia-result';
|
|
14
|
+
import type { DocumentFontCatalog, DocumentFontProvider, DocumentFontRegistration } from '@datalking/begonia-font-system';
|
|
15
|
+
import type { BrowserEditorCollaborationCapture, BrowserEditorCollaborationSessionLike, BrowserEditorCollaborationState, BrowserEditorSurfaceFactory } from './browser-editor-types-collaboration.ts';
|
|
16
|
+
export type { BrowserEditorSessionSnapshot } from './browser-command-types.ts';
|
|
17
|
+
import type { BrowserCommandId } from './browser-command-types.ts';
|
|
18
|
+
import type { BrowserEditorCommentCaptureInput, BrowserEditorSelectionCapture } from './browser-editor-selection-capture.ts';
|
|
19
|
+
import type { BrowserEditorSelectionHandle } from './browser-editor-selection-handle.ts';
|
|
20
|
+
import type { BrowserEditorSelectionRestoreResult } from './browser-editor-selection-restore.ts';
|
|
21
|
+
import type { BrowserEditorCommentActions, BrowserEditorCommentFocusActions, BrowserEditorCommentsDisplayActions, BrowserEditorDocumentModeActions, BrowserEditorReviewActions, BrowserEditorReviewFocusActions, BrowserEditorSelectionHandleAccess, BrowserEditorViewStateActions } from './browser-editor-contracts.ts';
|
|
22
|
+
import type { BrowserEditorAdvancedOoxmlActions } from './browser-editor-contracts-v1.ts';
|
|
23
|
+
import type { BrowserEditorState } from './browser-editor-types-state.ts';
|
|
24
|
+
import type { BrowserDocumentMode, BrowserEditorFitWidthOptions, BrowserEditorFlowMode, BrowserEditorLayoutMode, BrowserEditorModules, BrowserEditorZoomMode, BrowserEditorZoomViewportMetrics, BrowserPreviewNavigationRequest, BrowserPreviewNavigationRequestInput, BrowserTrackChangesReplacementMode, BrowserViewportState } from './browser-editor-types-shared.ts';
|
|
25
|
+
export interface BrowserEditorController extends BrowserEditorAdvancedOoxmlActions, BrowserEditorCommentActions, BrowserEditorCommentFocusActions, BrowserEditorCommentsDisplayActions, BrowserEditorDocumentModeActions, BrowserEditorReviewActions, BrowserEditorReviewFocusActions, BrowserEditorSelectionHandleAccess, BrowserEditorViewStateActions {
|
|
26
|
+
documentService: DocumentService;
|
|
27
|
+
documentApi: DocumentApi;
|
|
28
|
+
surface: DocumentSurface;
|
|
29
|
+
documentFontCatalog?: DocumentFontCatalog;
|
|
30
|
+
documentFontsReady?: Promise<DocumentFontRegistration | null>;
|
|
31
|
+
editorHost: EditorSessionHost<DocumentApi, BrowserCommandId, ReturnType<DocumentApi['selection']['current']>>;
|
|
32
|
+
editor: EditorSessionController<DocumentApi, BrowserCommandId, ReturnType<DocumentApi['selection']['current']>>;
|
|
33
|
+
modules: BrowserEditorModules;
|
|
34
|
+
actor: DocumentPermissionActor | null;
|
|
35
|
+
collaboration: BrowserEditorCollaborationState;
|
|
36
|
+
getState(): BrowserEditorState;
|
|
37
|
+
getCollaborationState(): BrowserEditorCollaborationState;
|
|
38
|
+
setModules(modules?: BrowserEditorModules): void;
|
|
39
|
+
getFlowMode(): BrowserEditorFlowMode;
|
|
40
|
+
getLayoutMode(): BrowserEditorLayoutMode;
|
|
41
|
+
getZoomPercent(): number;
|
|
42
|
+
getViewportState(): BrowserViewportState | null;
|
|
43
|
+
requestPreviewNavigation(request: BrowserPreviewNavigationRequestInput): BrowserPreviewNavigationRequest | null;
|
|
44
|
+
ackPreviewNavigationRequest(requestKey?: BrowserPreviewNavigationRequest['requestKey'] | null): void;
|
|
45
|
+
setFitWidthOptions(options?: Partial<BrowserEditorFitWidthOptions> | null): void;
|
|
46
|
+
setZoomViewportMetrics(metrics: BrowserEditorZoomViewportMetrics | null): void;
|
|
47
|
+
setTrackChangesReplacementMode(mode: BrowserTrackChangesReplacementMode): void;
|
|
48
|
+
setTrackChangesVisible(visible: boolean): void;
|
|
49
|
+
setCommentsReadOnly(readOnly: boolean): void;
|
|
50
|
+
setActor(actor?: DocumentPermissionActor | null): void;
|
|
51
|
+
setParticipant(participant: DocumentSurface['participant']): void;
|
|
52
|
+
subscribe(listener: (state: BrowserEditorState) => void): () => void;
|
|
53
|
+
attachCollaboration(session: BrowserEditorCollaborationSessionLike): Promise<BegoniaAsyncResult<BrowserEditorCollaborationState>>;
|
|
54
|
+
upgradeToCollaboration(session: BrowserEditorCollaborationSessionLike): Promise<BegoniaAsyncResult<BrowserEditorCollaborationState>>;
|
|
55
|
+
detachCollaboration(options?: {
|
|
56
|
+
destroySession?: boolean;
|
|
57
|
+
}): Promise<BegoniaAsyncResult<BrowserEditorCollaborationState>>;
|
|
58
|
+
saveCollaborationSnapshot(): Promise<BegoniaAsyncResult<BrowserEditorCollaborationCapture>>;
|
|
59
|
+
captureSelection(input?: SelectionCurrentInput): BrowserEditorSelectionCapture | null;
|
|
60
|
+
captureEffectiveSelection(input?: SelectionCurrentInput): BrowserEditorSelectionCapture | null;
|
|
61
|
+
readEffectiveSelection(input?: SelectionCurrentInput): BrowserEditorSelectionCapture | null;
|
|
62
|
+
captureSelectionHandleFromCapture(capture: BrowserEditorSelectionCapture | null): BrowserEditorSelectionHandle | null;
|
|
63
|
+
readSelectionCapture(capture: BrowserEditorSelectionCapture | null, input?: SelectionCurrentInput): BrowserEditorSelectionCapture | null;
|
|
64
|
+
resolveSelectionCapture(capture: BrowserEditorSelectionCapture | null, input?: SelectionCurrentInput): BrowserEditorSelectionCapture | null;
|
|
65
|
+
restoreSelectionCapture(capture: BrowserEditorSelectionCapture | null, options?: {
|
|
66
|
+
focus?: boolean;
|
|
67
|
+
}): BrowserEditorSelectionRestoreResult;
|
|
68
|
+
restoreSelectionHandle(handle: BrowserEditorSelectionHandle | null, options?: {
|
|
69
|
+
focus?: boolean;
|
|
70
|
+
}): BrowserEditorSelectionRestoreResult;
|
|
71
|
+
capturePointSelection(input: SelectionCurrentInput & {
|
|
72
|
+
clientX: number;
|
|
73
|
+
clientY: number;
|
|
74
|
+
}): BrowserEditorSelectionCapture | null;
|
|
75
|
+
readPointSelection(input: SelectionCurrentInput & {
|
|
76
|
+
clientX: number;
|
|
77
|
+
clientY: number;
|
|
78
|
+
}): BrowserEditorSelectionCapture | null;
|
|
79
|
+
createCommentFromCapture(capture: BrowserEditorCommentCaptureInput | null, text: string, options?: {
|
|
80
|
+
isInternal?: boolean;
|
|
81
|
+
}): ReturnType<DocumentApi['comments']['create']>;
|
|
82
|
+
search(query: string, options?: Parameters<DocumentApi['search']['query']>[1]): ReturnType<DocumentApi['search']['query']>;
|
|
83
|
+
nextSearchHit(): ReturnType<DocumentApi['search']['next']>;
|
|
84
|
+
previousSearchHit(): ReturnType<DocumentApi['search']['previous']>;
|
|
85
|
+
clearSearch(): void;
|
|
86
|
+
replaceSearchHit(hitId: string, text: string): ReturnType<DocumentApi['search']['replace']>;
|
|
87
|
+
replaceAllSearchHits(text: string): ReturnType<DocumentApi['search']['replaceAll']>;
|
|
88
|
+
ignoreProofingDiagnostic(diagnosticId: string): ReturnType<DocumentApi['proofing']['ignore']>;
|
|
89
|
+
acceptProofingSuggestion(diagnosticId: string): ReturnType<DocumentApi['proofing']['acceptSuggestion']>;
|
|
90
|
+
replaceProofingDiagnosticTracked(diagnosticId: string, text: string): ReturnType<DocumentApi['proofing']['replaceTracked']>;
|
|
91
|
+
appendMathToCurrentTextblock(model: Parameters<DocumentApi['ooxml']['math']['appendInline']>[1], options?: Parameters<DocumentApi['ooxml']['math']['appendInline']>[2]): ReturnType<DocumentApi['ooxml']['math']['appendInline']>;
|
|
92
|
+
appendMathToCurrentTextblockTracked(model: Parameters<DocumentApi['ooxml']['math']['appendInlineTracked']>[1], context?: Parameters<DocumentApi['ooxml']['math']['appendInlineTracked']>[3], options?: Parameters<DocumentApi['ooxml']['math']['appendInlineTracked']>[4]): ReturnType<DocumentApi['ooxml']['math']['appendInlineTracked']>;
|
|
93
|
+
insertChartAfterCurrentBlock(model: Parameters<DocumentApi['ooxml']['charts']['insertBlock']>[1], options?: Parameters<DocumentApi['ooxml']['charts']['insertBlock']>[2]): ReturnType<DocumentApi['ooxml']['charts']['insertBlock']>;
|
|
94
|
+
insertChartAfterCurrentBlockTracked(model: Parameters<DocumentApi['ooxml']['charts']['insertBlockTracked']>[1], context?: Parameters<DocumentApi['ooxml']['charts']['insertBlockTracked']>[3], options?: Parameters<DocumentApi['ooxml']['charts']['insertBlockTracked']>[4]): ReturnType<DocumentApi['ooxml']['charts']['insertBlockTracked']>;
|
|
95
|
+
insertShapeAfterCurrentBlock(model: Parameters<DocumentApi['ooxml']['shapes']['insertBlock']>[1], options?: Parameters<DocumentApi['ooxml']['shapes']['insertBlock']>[2]): ReturnType<DocumentApi['ooxml']['shapes']['insertBlock']>;
|
|
96
|
+
insertShapeAfterCurrentBlockTracked(model: Parameters<DocumentApi['ooxml']['shapes']['insertBlockTracked']>[1], context?: Parameters<DocumentApi['ooxml']['shapes']['insertBlockTracked']>[3], options?: Parameters<DocumentApi['ooxml']['shapes']['insertBlockTracked']>[4]): ReturnType<DocumentApi['ooxml']['shapes']['insertBlockTracked']>;
|
|
97
|
+
updateSelectedAdvancedOoxml(patch: Parameters<DocumentApi['ooxml']['update']>[1]): ReturnType<DocumentApi['ooxml']['update']>;
|
|
98
|
+
removeSelectedAdvancedOoxml(): ReturnType<DocumentApi['ooxml']['remove']>;
|
|
99
|
+
setSelectedChartSeries(seriesIndex: number, series: Parameters<DocumentApi['ooxml']['charts']['setSeries']>[2]): ReturnType<DocumentApi['ooxml']['charts']['setSeries']>;
|
|
100
|
+
removeSelectedChartSeries(seriesIndex: number): ReturnType<DocumentApi['ooxml']['charts']['removeSeries']>;
|
|
101
|
+
setLink(href: string, title?: string | null): boolean;
|
|
102
|
+
setLinkFromCapture(capture: BrowserEditorSelectionCapture | null, href: string, title?: string | null, options?: {
|
|
103
|
+
restoreSelection?: boolean;
|
|
104
|
+
}): boolean;
|
|
105
|
+
setLinkFromHandle(handle: BrowserEditorSelectionHandle | null, href: string, title?: string | null, options?: {
|
|
106
|
+
restoreSelection?: boolean;
|
|
107
|
+
}): boolean;
|
|
108
|
+
clearLink(): boolean;
|
|
109
|
+
clearLinkFromCapture(capture: BrowserEditorSelectionCapture | null, options?: {
|
|
110
|
+
restoreSelection?: boolean;
|
|
111
|
+
}): boolean;
|
|
112
|
+
clearLinkFromHandle(handle: BrowserEditorSelectionHandle | null, options?: {
|
|
113
|
+
restoreSelection?: boolean;
|
|
114
|
+
}): boolean;
|
|
115
|
+
updateActiveLink(href: string, title?: string | null): boolean;
|
|
116
|
+
clearActiveLink(): boolean;
|
|
117
|
+
closeLinkPopover(): void;
|
|
118
|
+
closeContextMenu(): void;
|
|
119
|
+
destroy(): void;
|
|
120
|
+
}
|
|
121
|
+
export type CreateBrowserEditorOptions = Omit<DocumentSurfaceOptions, 'element'> & {
|
|
122
|
+
element: HTMLElement;
|
|
123
|
+
templates?: DocumentTemplatesAdapter | null;
|
|
124
|
+
viewSelect?: boolean;
|
|
125
|
+
documentMode?: BrowserDocumentMode;
|
|
126
|
+
flowMode?: BrowserEditorFlowMode;
|
|
127
|
+
layoutMode?: BrowserEditorLayoutMode;
|
|
128
|
+
zoomPercent?: number;
|
|
129
|
+
zoomMode?: BrowserEditorZoomMode;
|
|
130
|
+
fitWidthOptions?: Partial<BrowserEditorFitWidthOptions> | null;
|
|
131
|
+
actor?: DocumentPermissionActor | null;
|
|
132
|
+
permissionResolver?: DocumentPermissionResolver;
|
|
133
|
+
modules?: BrowserEditorModules;
|
|
134
|
+
features?: readonly SurfaceFeatureDefinition[];
|
|
135
|
+
enableEmbeddedAdvancedOoxmlEditors?: boolean;
|
|
136
|
+
collaborationSession?: BrowserEditorCollaborationSessionLike | null;
|
|
137
|
+
surfaceFactory?: BrowserEditorSurfaceFactory;
|
|
138
|
+
documentFontProvider?: DocumentFontProvider | null;
|
|
139
|
+
};
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
import type { DocumentApiPermissionResolver as DocumentPermissionResolver } from '@datalking/begonia-document-api/core';
|
|
2
|
+
import type { EditorCommentVisibilityMode, EditorDocumentMode, EditorFlowMode, EditorLayoutMode, EditorPreviewNavigationRequest, EditorTrackChangesDisplayMode, EditorTrackChangesReplacementMode, EditorViewportAnchor, EditorViewportRequestKey, EditorViewportState, EditorZoomMode, EditorZoomViewportMetrics } from '@datalking/begonia-editor-contracts';
|
|
3
|
+
import type { ViewportFitMetrics, ViewportFitMode, ViewportFitSnapshot, ViewportFitWidthOptions } from '@datalking/begonia-layout-renderer/core';
|
|
4
|
+
import type { BrowserEditorSelectionCapture } from './browser-editor-selection-capture.ts';
|
|
5
|
+
import type { BrowserEditorOverlayHost } from './browser-editor-ui-types.ts';
|
|
6
|
+
export type BrowserDocumentMode = EditorDocumentMode;
|
|
7
|
+
export type BrowserEditorFlowMode = EditorFlowMode;
|
|
8
|
+
export type BrowserEditorLayoutMode = EditorLayoutMode;
|
|
9
|
+
export type BrowserEditorZoomMode = EditorZoomMode & ViewportFitMode;
|
|
10
|
+
export type BrowserPreviewControllerNavigationMode = 'consume' | 'bootstrap' | 'ignore';
|
|
11
|
+
export type BrowserTrackChangesDisplayMode = EditorTrackChangesDisplayMode;
|
|
12
|
+
export type BrowserTrackChangesReplacementMode = EditorTrackChangesReplacementMode;
|
|
13
|
+
export type BrowserCommentVisibilityMode = EditorCommentVisibilityMode;
|
|
14
|
+
export type BrowserViewportRequestKey = EditorViewportRequestKey;
|
|
15
|
+
export type BrowserResolvedViewportRequestKey = string | number;
|
|
16
|
+
export interface BrowserViewportAnchor extends EditorViewportAnchor {
|
|
17
|
+
}
|
|
18
|
+
export interface BrowserViewportState extends EditorViewportState {
|
|
19
|
+
viewportAnchor: BrowserViewportAnchor | null;
|
|
20
|
+
visiblePageIndexes: number[];
|
|
21
|
+
visiblePageNumbers: number[];
|
|
22
|
+
mountedPageIndexes: number[];
|
|
23
|
+
mountedPageNumbers: number[];
|
|
24
|
+
}
|
|
25
|
+
export interface BrowserPreviewNavigationRequest extends EditorPreviewNavigationRequest {
|
|
26
|
+
viewportAnchor: BrowserViewportAnchor | null;
|
|
27
|
+
}
|
|
28
|
+
export interface BrowserPreviewNavigationRequestInput {
|
|
29
|
+
requestKey?: BrowserViewportRequestKey | undefined;
|
|
30
|
+
anchorPageNumber?: number | null | undefined;
|
|
31
|
+
viewportAnchor?: BrowserViewportAnchor | null | undefined;
|
|
32
|
+
}
|
|
33
|
+
export interface BrowserViewStatePatch {
|
|
34
|
+
flowMode?: BrowserEditorFlowMode;
|
|
35
|
+
layoutMode?: BrowserEditorLayoutMode;
|
|
36
|
+
zoomPercent?: number;
|
|
37
|
+
viewport?: BrowserViewportState | null;
|
|
38
|
+
viewportRequestKey?: BrowserViewportRequestKey;
|
|
39
|
+
}
|
|
40
|
+
export type BrowserEditorFitWidthOptions = ViewportFitWidthOptions;
|
|
41
|
+
export type BrowserEditorZoomViewportMetrics = EditorZoomViewportMetrics & ViewportFitMetrics;
|
|
42
|
+
export type BrowserEditorZoomState = ViewportFitSnapshot;
|
|
43
|
+
export interface BrowserOverlayPosition {
|
|
44
|
+
left: number;
|
|
45
|
+
top: number;
|
|
46
|
+
}
|
|
47
|
+
export interface BrowserLinkPopoverDefaultResolution {
|
|
48
|
+
type: 'default';
|
|
49
|
+
}
|
|
50
|
+
export interface BrowserLinkPopoverNoneResolution {
|
|
51
|
+
type: 'none';
|
|
52
|
+
}
|
|
53
|
+
type BrowserLinkPopoverController = {
|
|
54
|
+
updateActiveLink(href: string, title?: string | null): unknown;
|
|
55
|
+
clearActiveLink(): unknown;
|
|
56
|
+
closeLinkPopover?: () => void;
|
|
57
|
+
};
|
|
58
|
+
export interface BrowserLinkPopoverExternalResolution {
|
|
59
|
+
type: 'external';
|
|
60
|
+
render: (context: {
|
|
61
|
+
container: HTMLElement;
|
|
62
|
+
closePopover: () => void;
|
|
63
|
+
controller: BrowserLinkPopoverController;
|
|
64
|
+
href: string;
|
|
65
|
+
title: string | null;
|
|
66
|
+
}) => {
|
|
67
|
+
destroy?: () => void;
|
|
68
|
+
} | void;
|
|
69
|
+
}
|
|
70
|
+
export type BrowserLinkPopoverResolution = BrowserLinkPopoverDefaultResolution | BrowserLinkPopoverNoneResolution | BrowserLinkPopoverExternalResolution;
|
|
71
|
+
export interface BrowserLinkPopoverContext {
|
|
72
|
+
host: BrowserEditorOverlayHost;
|
|
73
|
+
href: string;
|
|
74
|
+
title: string | null;
|
|
75
|
+
target: string | null;
|
|
76
|
+
rel: string | null;
|
|
77
|
+
tooltip: string | null;
|
|
78
|
+
element: HTMLAnchorElement;
|
|
79
|
+
clientX: number;
|
|
80
|
+
clientY: number;
|
|
81
|
+
isAnchorLink: boolean;
|
|
82
|
+
documentMode: BrowserDocumentMode;
|
|
83
|
+
position: BrowserOverlayPosition;
|
|
84
|
+
closePopover: () => void;
|
|
85
|
+
}
|
|
86
|
+
export interface BrowserLinkPopoverState {
|
|
87
|
+
host: BrowserEditorOverlayHost;
|
|
88
|
+
href: string;
|
|
89
|
+
title: string | null;
|
|
90
|
+
target: string | null;
|
|
91
|
+
rel: string | null;
|
|
92
|
+
tooltip: string | null;
|
|
93
|
+
element: HTMLAnchorElement;
|
|
94
|
+
clientX: number;
|
|
95
|
+
clientY: number;
|
|
96
|
+
isAnchorLink: boolean;
|
|
97
|
+
documentMode: BrowserDocumentMode;
|
|
98
|
+
position: BrowserOverlayPosition;
|
|
99
|
+
resolution: Exclude<BrowserLinkPopoverResolution, BrowserLinkPopoverNoneResolution>;
|
|
100
|
+
}
|
|
101
|
+
export interface BrowserLinkModuleOptions {
|
|
102
|
+
enabled?: boolean;
|
|
103
|
+
popoverResolver?: (context: BrowserLinkPopoverContext) => BrowserLinkPopoverResolution | null | undefined;
|
|
104
|
+
}
|
|
105
|
+
export interface BrowserTrackChangesModuleOptions {
|
|
106
|
+
enabled?: boolean;
|
|
107
|
+
visible?: boolean;
|
|
108
|
+
mode?: BrowserTrackChangesDisplayMode;
|
|
109
|
+
replacements?: BrowserTrackChangesReplacementMode;
|
|
110
|
+
}
|
|
111
|
+
export interface BrowserCommentsModuleOptions {
|
|
112
|
+
enabled?: boolean;
|
|
113
|
+
visible?: boolean;
|
|
114
|
+
readOnly?: boolean;
|
|
115
|
+
allowResolve?: boolean;
|
|
116
|
+
showResolved?: boolean;
|
|
117
|
+
visibility?: BrowserCommentVisibilityMode;
|
|
118
|
+
useInternalExternalComments?: boolean;
|
|
119
|
+
suppressInternalExternal?: boolean;
|
|
120
|
+
permissionResolver?: DocumentPermissionResolver;
|
|
121
|
+
}
|
|
122
|
+
export interface BrowserContextMenuContext {
|
|
123
|
+
host: BrowserEditorOverlayHost;
|
|
124
|
+
trigger: 'contextmenu';
|
|
125
|
+
selectedText: string;
|
|
126
|
+
hasSelection: boolean;
|
|
127
|
+
selectionStart: number;
|
|
128
|
+
selectionEnd: number;
|
|
129
|
+
isInTable: boolean;
|
|
130
|
+
isInList: boolean;
|
|
131
|
+
isTrackedChange: boolean;
|
|
132
|
+
trackedChangeIds: string[];
|
|
133
|
+
hasAmbiguousPointReviewTarget: boolean;
|
|
134
|
+
pointReviewTrackedChangeIds: string[];
|
|
135
|
+
pointReviewCommentIds: string[];
|
|
136
|
+
documentMode: BrowserDocumentMode;
|
|
137
|
+
currentNodeType: string | null;
|
|
138
|
+
activeCommentIds: string[];
|
|
139
|
+
activeMarks: string[];
|
|
140
|
+
selectionCapture: BrowserEditorSelectionCapture | null;
|
|
141
|
+
actionSelectionCapture: BrowserEditorSelectionCapture | null;
|
|
142
|
+
pointSelectionCapture: BrowserEditorSelectionCapture | null;
|
|
143
|
+
isEditable: boolean;
|
|
144
|
+
pos: number | null;
|
|
145
|
+
clientX: number;
|
|
146
|
+
clientY: number;
|
|
147
|
+
position: BrowserOverlayPosition;
|
|
148
|
+
}
|
|
149
|
+
export interface BrowserContextMenuItem {
|
|
150
|
+
id: string;
|
|
151
|
+
label: string;
|
|
152
|
+
action: (context: BrowserContextMenuContext) => void;
|
|
153
|
+
showWhen?: (context: BrowserContextMenuContext) => boolean;
|
|
154
|
+
enabledWhen?: (context: BrowserContextMenuContext) => boolean;
|
|
155
|
+
disabledReason?: string | ((context: BrowserContextMenuContext) => string | null | undefined);
|
|
156
|
+
tone?: 'default' | 'success' | 'danger';
|
|
157
|
+
}
|
|
158
|
+
export interface BrowserContextMenuSection {
|
|
159
|
+
id: string;
|
|
160
|
+
label?: string | null;
|
|
161
|
+
items: readonly BrowserContextMenuItem[];
|
|
162
|
+
}
|
|
163
|
+
export interface BrowserResolvedContextMenuItem extends Omit<BrowserContextMenuItem, 'disabledReason'> {
|
|
164
|
+
enabled: boolean;
|
|
165
|
+
disabledReason: string | null;
|
|
166
|
+
}
|
|
167
|
+
export interface BrowserResolvedContextMenuSection {
|
|
168
|
+
id: string;
|
|
169
|
+
label?: string | null;
|
|
170
|
+
items: readonly BrowserResolvedContextMenuItem[];
|
|
171
|
+
}
|
|
172
|
+
export interface BrowserContextMenuState {
|
|
173
|
+
context: BrowserContextMenuContext;
|
|
174
|
+
sections: readonly BrowserResolvedContextMenuSection[];
|
|
175
|
+
}
|
|
176
|
+
export interface BrowserContextMenuOptions {
|
|
177
|
+
enabled?: boolean;
|
|
178
|
+
includeDefaultItems?: boolean;
|
|
179
|
+
customItems?: readonly BrowserContextMenuSection[];
|
|
180
|
+
menuProvider?: (context: BrowserContextMenuContext, sections: readonly BrowserContextMenuSection[]) => readonly BrowserContextMenuSection[] | null | undefined;
|
|
181
|
+
}
|
|
182
|
+
export interface BrowserEditorModules {
|
|
183
|
+
links?: BrowserLinkModuleOptions;
|
|
184
|
+
contextMenu?: BrowserContextMenuOptions;
|
|
185
|
+
trackChanges?: BrowserTrackChangesModuleOptions;
|
|
186
|
+
comments?: BrowserCommentsModuleOptions;
|
|
187
|
+
}
|
|
188
|
+
export interface BrowserTrackChangesDisplayState {
|
|
189
|
+
enabled: boolean;
|
|
190
|
+
visible: boolean;
|
|
191
|
+
mode: BrowserTrackChangesDisplayMode;
|
|
192
|
+
replacements: BrowserTrackChangesReplacementMode;
|
|
193
|
+
}
|
|
194
|
+
export interface BrowserCommentsDisplayState {
|
|
195
|
+
enabled: boolean;
|
|
196
|
+
visible: boolean;
|
|
197
|
+
readOnly: boolean;
|
|
198
|
+
allowResolve: boolean;
|
|
199
|
+
showResolved: boolean;
|
|
200
|
+
visibility: BrowserCommentVisibilityMode;
|
|
201
|
+
useInternalExternalComments: boolean;
|
|
202
|
+
suppressInternalExternal: boolean;
|
|
203
|
+
enforceVisibilityPolicy: boolean;
|
|
204
|
+
}
|
|
205
|
+
export {};
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import type { DocumentApiCommentThreadPermissions as CommentThreadPermissions, DocumentApiContract as DocumentApi, DocumentApiReviewPermissionRecord as ReviewPermissionRecord } from '@datalking/begonia-document-api/core';
|
|
2
|
+
import type { EditorSelectionSnapshot, EditorUiSnapshot } from '@datalking/begonia-editor-contracts';
|
|
3
|
+
import type { BrowserEditorCollaborationState } from './browser-editor-collaboration-state-types.ts';
|
|
4
|
+
import type { BrowserCommentsDisplayState, BrowserContextMenuState, BrowserDocumentMode, BrowserEditorFlowMode, BrowserEditorLayoutMode, BrowserLinkPopoverState, BrowserPreviewNavigationRequest, BrowserTrackChangesDisplayState, BrowserEditorZoomState, BrowserViewportRequestKey, BrowserViewportState } from './browser-editor-types-shared.ts';
|
|
5
|
+
export interface BrowserEditorState {
|
|
6
|
+
toolbar: EditorUiSnapshot;
|
|
7
|
+
comments: ReturnType<DocumentApi['comments']['list']>;
|
|
8
|
+
commentPermissions: Record<string, CommentThreadPermissions | null>;
|
|
9
|
+
activeCommentId?: string | null;
|
|
10
|
+
activeCommentIds?: readonly string[];
|
|
11
|
+
revisions: ReturnType<DocumentApi['review']['list']>;
|
|
12
|
+
activeRevisionId?: string | null;
|
|
13
|
+
activeRevisionIds?: readonly string[];
|
|
14
|
+
reviewPermissions: Record<string, ReviewPermissionRecord | undefined>;
|
|
15
|
+
reviewTimeline: ReturnType<DocumentApi['review']['timeline']>;
|
|
16
|
+
reviewTimelineSummary: ReturnType<DocumentApi['review']['timelineSummary']>;
|
|
17
|
+
search: {
|
|
18
|
+
query: string;
|
|
19
|
+
hits: ReturnType<DocumentApi['search']['query']>;
|
|
20
|
+
activeHitId: string | null;
|
|
21
|
+
};
|
|
22
|
+
proofing: {
|
|
23
|
+
diagnostics: ReturnType<DocumentApi['proofing']['list']>;
|
|
24
|
+
};
|
|
25
|
+
advancedOoxml: {
|
|
26
|
+
selected: ReturnType<DocumentApi['ooxml']['get']>;
|
|
27
|
+
};
|
|
28
|
+
selectionInfo: ReturnType<DocumentApi['selection']['current']>;
|
|
29
|
+
selection: EditorSelectionSnapshot;
|
|
30
|
+
editable: boolean;
|
|
31
|
+
documentMode: BrowserDocumentMode;
|
|
32
|
+
flowMode: BrowserEditorFlowMode;
|
|
33
|
+
layoutMode: BrowserEditorLayoutMode;
|
|
34
|
+
preferredPaginatedLayoutMode: BrowserEditorLayoutMode;
|
|
35
|
+
zoomPercent: number;
|
|
36
|
+
zoom: BrowserEditorZoomState;
|
|
37
|
+
viewport: BrowserViewportState | null;
|
|
38
|
+
viewportRequestKey: BrowserViewportRequestKey;
|
|
39
|
+
previewNavigationRequest: BrowserPreviewNavigationRequest | null;
|
|
40
|
+
trackChanges: BrowserTrackChangesDisplayState;
|
|
41
|
+
commentsDisplay: BrowserCommentsDisplayState;
|
|
42
|
+
collaboration: BrowserEditorCollaborationState;
|
|
43
|
+
linkPopover: BrowserLinkPopoverState | null;
|
|
44
|
+
contextMenu: BrowserContextMenuState | null;
|
|
45
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export type { BrowserEditorCollaborationCapture, BrowserEditorCollaborationConnectionState, BrowserEditorCollaborationSessionLike, BrowserEditorCollaborationSessionSnapshot, BrowserEditorCollaborationState, BrowserEditorSurfaceFactory, BrowserEditorSurfaceFactoryRequest, } from './browser-editor-types-collaboration.ts';
|
|
2
|
+
export type { BrowserEditorController, CreateBrowserEditorOptions, } from './browser-editor-types-controller.ts';
|
|
3
|
+
export type { BrowserEditorSessionSnapshot } from './browser-command-types.ts';
|
|
4
|
+
export type { BrowserEditorSelectionHandle, BrowserEditorSelectionHandleKind, } from './browser-editor-selection-handle.ts';
|
|
5
|
+
export type { BrowserEditorSelectionRestoreReason, BrowserEditorSelectionRestoreResult, } from './browser-editor-selection-restore.ts';
|
|
6
|
+
export type { BrowserEditorState } from './browser-editor-types-state.ts';
|
|
7
|
+
export type { BrowserCommentVisibilityMode, BrowserCommentsDisplayState, BrowserCommentsModuleOptions, BrowserContextMenuContext, BrowserContextMenuItem, BrowserContextMenuOptions, BrowserContextMenuSection, BrowserContextMenuState, BrowserDocumentMode, BrowserEditorFlowMode, BrowserEditorLayoutMode, BrowserEditorFitWidthOptions, BrowserEditorModules, BrowserEditorZoomMode, BrowserEditorZoomState, BrowserEditorZoomViewportMetrics, BrowserLinkModuleOptions, BrowserLinkPopoverContext, BrowserLinkPopoverDefaultResolution, BrowserLinkPopoverExternalResolution, BrowserLinkPopoverResolution, BrowserLinkPopoverState, BrowserOverlayPosition, BrowserPreviewControllerNavigationMode, BrowserPreviewNavigationRequest, BrowserPreviewNavigationRequestInput, BrowserResolvedContextMenuItem, BrowserResolvedViewportRequestKey, BrowserResolvedContextMenuSection, BrowserTrackChangesDisplayMode, BrowserTrackChangesDisplayState, BrowserTrackChangesModuleOptions, BrowserTrackChangesReplacementMode, BrowserViewStatePatch, BrowserViewportAnchor, BrowserViewportRequestKey, BrowserViewportState, } from './browser-editor-types-shared.ts';
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { BrowserEditorUi } from './browser-editor-ui-types.ts';
|
|
2
|
+
import type { BrowserEditorController } from './browser-editor-types-controller.ts';
|
|
3
|
+
export declare function createBrowserEditorUiController(editor: BrowserEditorController): BrowserEditorUi;
|
|
4
|
+
export { createBrowserEditorUiFromController } from './browser-editor-host.ts';
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { BrowserPaginatedPreviewEditorBinding } from './browser-paginated-preview-editor-binding.ts';
|
|
2
|
+
import type { BrowserEditorUi, BrowserEditorUiHost } from './browser-editor-ui-types.ts';
|
|
3
|
+
export type BrowserEditorUiSource = BrowserEditorUi | BrowserEditorUiHost;
|
|
4
|
+
export declare function resolveBrowserEditorUiHost(value: BrowserEditorUiSource | null | undefined): BrowserEditorUiHost | null;
|
|
5
|
+
export declare function resolveBrowserEditorPreviewBinding(value: BrowserEditorUiSource | BrowserPaginatedPreviewEditorBinding | null | undefined): BrowserPaginatedPreviewEditorBinding | null;
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import type { DocumentApiContract as DocumentApi, DocumentApiPermissionActor as DocumentPermissionActor } from '@datalking/begonia-document-api/core';
|
|
2
|
+
import type { EditorSessionController, EditorSessionHost } from '@datalking/begonia-editor-contracts';
|
|
3
|
+
import type { BrowserCommandId, BrowserCommandSnapshotSource } from './browser-command-types.ts';
|
|
4
|
+
import type { BrowserEditorCommentsController } from './browser-editor-comments-types.ts';
|
|
5
|
+
import type { BrowserPaginatedPreviewEditorBinding } from './browser-paginated-preview-editor-binding.ts';
|
|
6
|
+
import type { BrowserEditorTrackChangesController } from './browser-editor-track-change-types.ts';
|
|
7
|
+
import type { BrowserContextMenuState, BrowserLinkPopoverState } from './browser-editor-types-shared.ts';
|
|
8
|
+
import type { BrowserEditorActiveLinkActions, BrowserEditorCommentActions, BrowserEditorCommentFocusActions, BrowserEditorCommentsDisplayActions, BrowserEditorDocumentModeActions, BrowserEditorLinkSelectionActions, BrowserEditorReviewFocusActions, BrowserEditorReviewActions, BrowserEditorSelectionHandleAccess, BrowserEditorSelectionTargetActions, BrowserEditorViewStateActions } from './browser-editor-contracts.ts';
|
|
9
|
+
import type { BrowserEditorCommentsDisplayController, BrowserEditorDocumentModeController, BrowserEditorSelectionController, BrowserEditorViewController, BrowserEditorViewportController, BrowserEditorZoomController } from './browser-editor-domain-types.ts';
|
|
10
|
+
import type { BrowserEditorViewportHandle } from './browser-editor-viewport-types.ts';
|
|
11
|
+
export type BrowserEditorSelectionInfo = ReturnType<DocumentApi['selection']['current']>;
|
|
12
|
+
export type BrowserEditorSessionHost = EditorSessionHost<DocumentApi, BrowserCommandId, BrowserEditorSelectionInfo>;
|
|
13
|
+
export interface BrowserEditorOverlayActions {
|
|
14
|
+
closeLinkPopover?(): void;
|
|
15
|
+
closeContextMenu?(): void;
|
|
16
|
+
}
|
|
17
|
+
export interface BrowserEditorOverlayStateSnapshot {
|
|
18
|
+
linkPopover: BrowserLinkPopoverState | null;
|
|
19
|
+
contextMenu: BrowserContextMenuState | null;
|
|
20
|
+
}
|
|
21
|
+
export interface BrowserEditorOverlayStateSource {
|
|
22
|
+
getSnapshot(): BrowserEditorOverlayStateSnapshot;
|
|
23
|
+
subscribe(listener: () => void): () => void;
|
|
24
|
+
}
|
|
25
|
+
export interface BrowserEditorUiHost extends BrowserCommandSnapshotSource {
|
|
26
|
+
readonly actor: DocumentPermissionActor | null;
|
|
27
|
+
readonly session: BrowserEditorSessionHost;
|
|
28
|
+
readonly documentApi: DocumentApi;
|
|
29
|
+
readonly selectionHandles: BrowserEditorSelectionHandleAccess;
|
|
30
|
+
readonly linkSelection: BrowserEditorLinkSelectionActions;
|
|
31
|
+
readonly activeLink: BrowserEditorActiveLinkActions;
|
|
32
|
+
readonly view: BrowserEditorViewStateActions;
|
|
33
|
+
readonly documentMode: BrowserEditorDocumentModeActions;
|
|
34
|
+
readonly commentsDisplay: BrowserEditorCommentsDisplayActions;
|
|
35
|
+
readonly commentActions: BrowserEditorCommentActions;
|
|
36
|
+
readonly commentFocus: BrowserEditorCommentFocusActions;
|
|
37
|
+
readonly reviewActions: BrowserEditorReviewActions;
|
|
38
|
+
readonly reviewFocus: BrowserEditorReviewFocusActions;
|
|
39
|
+
readonly selectionTargets: BrowserEditorSelectionTargetActions;
|
|
40
|
+
readonly browserViewport: BrowserEditorViewportHandle;
|
|
41
|
+
readonly preview: BrowserPaginatedPreviewEditorBinding;
|
|
42
|
+
readonly overlayState: BrowserEditorOverlayStateSource;
|
|
43
|
+
readonly overlays?: BrowserEditorOverlayActions;
|
|
44
|
+
}
|
|
45
|
+
export interface BrowserEditorOverlayHost extends Omit<BrowserEditorUiHost, 'overlays'> {
|
|
46
|
+
readonly overlays: BrowserEditorOverlayActions;
|
|
47
|
+
}
|
|
48
|
+
export interface BrowserEditorUi extends EditorSessionController<DocumentApi, BrowserCommandId, BrowserEditorSelectionInfo>, BrowserCommandSnapshotSource {
|
|
49
|
+
readonly host: BrowserEditorUiHost;
|
|
50
|
+
readonly actor: BrowserEditorUiHost['actor'];
|
|
51
|
+
readonly session: BrowserEditorSessionHost;
|
|
52
|
+
readonly documentApi: DocumentApi;
|
|
53
|
+
readonly selection: BrowserEditorSelectionController;
|
|
54
|
+
readonly selectionHandles: BrowserEditorUiHost['selectionHandles'];
|
|
55
|
+
readonly linkSelection: BrowserEditorUiHost['linkSelection'];
|
|
56
|
+
readonly activeLink: BrowserEditorUiHost['activeLink'];
|
|
57
|
+
readonly view: BrowserEditorViewController;
|
|
58
|
+
readonly documentMode: BrowserEditorDocumentModeController;
|
|
59
|
+
readonly commentsDisplay: BrowserEditorCommentsDisplayController;
|
|
60
|
+
readonly commentActions: BrowserEditorUiHost['commentActions'];
|
|
61
|
+
readonly commentFocus: BrowserEditorUiHost['commentFocus'];
|
|
62
|
+
readonly comments: BrowserEditorCommentsController;
|
|
63
|
+
readonly reviewActions: BrowserEditorUiHost['reviewActions'];
|
|
64
|
+
readonly reviewFocus: BrowserEditorUiHost['reviewFocus'];
|
|
65
|
+
readonly trackChanges: BrowserEditorTrackChangesController;
|
|
66
|
+
readonly selectionTargets: BrowserEditorUiHost['selectionTargets'];
|
|
67
|
+
readonly viewport: BrowserEditorViewportController;
|
|
68
|
+
readonly zoom: BrowserEditorZoomController;
|
|
69
|
+
readonly browserViewport: BrowserEditorUiHost['browserViewport'];
|
|
70
|
+
readonly preview: BrowserEditorUiHost['preview'];
|
|
71
|
+
readonly overlayState: BrowserEditorUiHost['overlayState'];
|
|
72
|
+
readonly overlays: BrowserEditorOverlayActions;
|
|
73
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { BrowserEditorFlowMode, BrowserEditorLayoutMode, BrowserEditorZoomMode, BrowserViewStatePatch } from './browser-editor-types-shared.ts';
|
|
2
|
+
export interface BrowserViewIntentSnapshot {
|
|
3
|
+
flowMode: BrowserEditorFlowMode;
|
|
4
|
+
layoutMode: BrowserEditorLayoutMode;
|
|
5
|
+
preferredPaginatedLayoutMode: BrowserEditorLayoutMode;
|
|
6
|
+
zoomPercent: number;
|
|
7
|
+
zoomMode: BrowserEditorZoomMode;
|
|
8
|
+
}
|
|
9
|
+
export interface BrowserViewIntentSnapshotSource {
|
|
10
|
+
flowMode?: BrowserEditorFlowMode | null;
|
|
11
|
+
layoutMode?: BrowserEditorLayoutMode | null;
|
|
12
|
+
preferredPaginatedLayoutMode?: BrowserEditorLayoutMode | null;
|
|
13
|
+
zoomPercent?: number | null;
|
|
14
|
+
zoom?: {
|
|
15
|
+
percent?: number | null;
|
|
16
|
+
mode?: BrowserEditorZoomMode | null;
|
|
17
|
+
} | null;
|
|
18
|
+
}
|
|
19
|
+
export type BrowserViewIntent = {
|
|
20
|
+
type: 'flow';
|
|
21
|
+
flowMode: BrowserEditorFlowMode;
|
|
22
|
+
} | {
|
|
23
|
+
type: 'toggle-pagination';
|
|
24
|
+
} | {
|
|
25
|
+
type: 'layout';
|
|
26
|
+
layoutMode: BrowserEditorLayoutMode;
|
|
27
|
+
} | {
|
|
28
|
+
type: 'zoom';
|
|
29
|
+
zoomPercent: number;
|
|
30
|
+
};
|
|
31
|
+
export declare function resolveBrowserViewIntentSnapshot(source: BrowserViewIntentSnapshotSource | null | undefined): BrowserViewIntentSnapshot;
|
|
32
|
+
export declare function resolveBrowserViewIntentPatch(snapshot: Pick<BrowserViewIntentSnapshot, 'flowMode' | 'layoutMode' | 'preferredPaginatedLayoutMode'>, intent: BrowserViewIntent): BrowserViewStatePatch;
|
|
33
|
+
export declare function resolveBrowserViewLayoutMode(snapshot: Pick<BrowserViewIntentSnapshot, 'flowMode' | 'layoutMode' | 'preferredPaginatedLayoutMode'>): BrowserEditorLayoutMode;
|
|
34
|
+
export declare function resolveBrowserViewZoomMode(snapshot: Pick<BrowserViewIntentSnapshot, 'zoomMode'>): BrowserEditorZoomMode;
|
|
35
|
+
export declare function resolveBrowserZoomStep(currentZoomPercent: number, steps: readonly number[], direction: -1 | 1): number;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import type { DocumentPreferenceRecord } from '@datalking/begonia-doc-service/core';
|
|
2
|
+
import type { BrowserEditorFlowMode, BrowserEditorLayoutMode, BrowserViewportRequestKey, BrowserViewportState } from '../browser-editor-types.ts';
|
|
3
|
+
export declare function normalizeBrowserViewportPageAddress(pageIndexValue: unknown, pageNumberValue: unknown): {
|
|
4
|
+
pageIndex: number | null;
|
|
5
|
+
pageNumber: number | null;
|
|
6
|
+
};
|
|
7
|
+
interface BrowserViewportAnchorPageAddress {
|
|
8
|
+
pageIndex?: unknown;
|
|
9
|
+
pageNumber?: unknown;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Smallest and largest zoom a caller may request, as a percentage.
|
|
13
|
+
*
|
|
14
|
+
* The floor keeps the document from collapsing to a few pixels, and the
|
|
15
|
+
* ceiling keeps CSS `zoom` from being handed a multiplier that makes the
|
|
16
|
+
* browser lay out millions of pixels per line. Without the ceiling a
|
|
17
|
+
* `zoom: 1e9` accepted here becomes `zoom: 10000000` on the surface element,
|
|
18
|
+
* which hangs the renderer instead of failing.
|
|
19
|
+
*/
|
|
20
|
+
export declare const MIN_BROWSER_ZOOM_PERCENT = 10;
|
|
21
|
+
export declare const MAX_BROWSER_ZOOM_PERCENT = 500;
|
|
22
|
+
export declare function normalizeBrowserZoomPercent(value: unknown): number | null;
|
|
23
|
+
export declare function normalizeBrowserViewportRequestKey(value: unknown): BrowserViewportRequestKey;
|
|
24
|
+
export declare function sameBrowserViewportRequestKey(left: BrowserViewportRequestKey | undefined, right: BrowserViewportRequestKey | undefined): boolean;
|
|
25
|
+
export declare function hasFreshBrowserViewportRequest(left: BrowserViewportRequestKey | undefined, right: BrowserViewportRequestKey | undefined): boolean;
|
|
26
|
+
export declare function readBrowserZoomPercent(preferences: Pick<DocumentPreferenceRecord, 'zoomPercent'> | null | undefined): number;
|
|
27
|
+
export declare function isBrowserViewportStateCompatibleWithFlowMode(viewport: Pick<BrowserViewportState, 'flowMode'> | null | undefined, flowMode: BrowserEditorFlowMode): boolean;
|
|
28
|
+
export declare function isBrowserViewportStateCompatibleWithLayoutMode(viewport: Pick<BrowserViewportState, 'layoutMode'> | null | undefined, layoutMode: BrowserEditorLayoutMode): boolean;
|
|
29
|
+
export declare function isBrowserViewportStateCompatibleWithModes(viewport: Pick<BrowserViewportState, 'flowMode' | 'layoutMode'> | null | undefined, flowMode: BrowserEditorFlowMode, layoutMode: BrowserEditorLayoutMode): boolean;
|
|
30
|
+
export declare function sameBrowserViewportAnchor(left: BrowserViewportState['viewportAnchor'], right: BrowserViewportState['viewportAnchor']): boolean;
|
|
31
|
+
export declare function normalizeBrowserViewportAnchor(value: BrowserViewportState['viewportAnchor'] | null | undefined, fallbackPageAddress?: BrowserViewportAnchorPageAddress | null | undefined): import("@datalking/begonia-layout-renderer").PageViewportAnchor | null;
|
|
32
|
+
export declare function resolveCompatibleBrowserPreviewViewportAnchor(viewport: Pick<BrowserViewportState, 'viewportAnchor' | 'anchorPageIndex' | 'anchorPageNumber' | 'currentPageIndex' | 'currentPageNumber'> | null | undefined): import("@datalking/begonia-layout-renderer").PageViewportAnchor | null;
|
|
33
|
+
export declare function browserViewportStateHasExplicitModeConflict(viewport: Pick<BrowserViewportState, 'flowMode' | 'layoutMode'> | null | undefined, flowMode: BrowserEditorFlowMode, layoutMode: BrowserEditorLayoutMode): boolean;
|
|
34
|
+
export declare function sameBrowserViewportState(left: BrowserViewportState | null | undefined, right: BrowserViewportState | null | undefined): boolean;
|
|
35
|
+
export declare function sameBrowserViewportStateForControllerSync(left: BrowserViewportState | null | undefined, right: BrowserViewportState | null | undefined): boolean;
|
|
36
|
+
export declare function cloneBrowserViewportState(value: BrowserViewportState | null | undefined): BrowserViewportState | null;
|
|
37
|
+
export declare function fillBrowserViewportStateModes(viewport: BrowserViewportState | null | undefined, fallbackModes: {
|
|
38
|
+
flowMode?: BrowserEditorFlowMode | null | undefined;
|
|
39
|
+
layoutMode?: BrowserEditorLayoutMode | null | undefined;
|
|
40
|
+
}): BrowserViewportState | null;
|
|
41
|
+
export {};
|