@soeditor/plugin-sdk 0.5.0 → 1.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.
- package/README.md +20 -3
- package/dist/index.d.ts +11 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +24 -1
- package/dist/index.js.map +1 -1
- package/package.json +19 -9
package/README.md
CHANGED
|
@@ -1,6 +1,23 @@
|
|
|
1
1
|
# @soeditor/plugin-sdk
|
|
2
2
|
|
|
3
3
|
Narrow package-root facade for SoEditor plugin authors. It re-exports public
|
|
4
|
-
SoEditor-owned lifecycle, command, service,
|
|
5
|
-
|
|
6
|
-
library types.
|
|
4
|
+
SoEditor-owned lifecycle, command, service, structured-editing,
|
|
5
|
+
diagnostics, projection/layout, UI contribution, and FileManager contracts
|
|
6
|
+
without exposing implementation registries or third-party library types.
|
|
7
|
+
|
|
8
|
+
The SDK includes generic diagnostics workflow types and the adapter/service
|
|
9
|
+
contracts needed by alternate split-view integrations. Built-in accessibility
|
|
10
|
+
and SEO rule configuration remains owned by `@soeditor/html-tools`; the built-in
|
|
11
|
+
DOM layout factory remains owned by `@soeditor/layout`.
|
|
12
|
+
|
|
13
|
+
Structured block conversion contracts, the editor-owned registry token, and
|
|
14
|
+
operation/position mapping are re-exported from their `@soeditor/engine` owner.
|
|
15
|
+
Conversion callbacks use only SoEditor HTML values and cannot create editing
|
|
16
|
+
DOM; see the repository plugin guide for a complete custom-element example.
|
|
17
|
+
The experimental visual-decoration plugin, token, and immutable range types are
|
|
18
|
+
also exposed for non-canonical annotation providers.
|
|
19
|
+
|
|
20
|
+
The SDK also curates the comments/revisions plugin factories, service
|
|
21
|
+
tokens, immutable models, storage and permission contracts, review policy, and
|
|
22
|
+
versioned export types. Concrete controllers, rendering internals, and adapter
|
|
23
|
+
implementations remain in their owning packages.
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,17 @@
|
|
|
1
|
+
export { commentsServiceToken, createCommentsPlugin } from '@soeditor/comments';
|
|
2
|
+
export type { CommentAction, CommentAuthor, CommentDataExport, CommentMessage, CommentPermissionContext, CommentPermissionProvider, CommentRange, CommentsPluginOptions, CommentsService, CommentStorageAdapter, CommentThread, } from '@soeditor/comments';
|
|
1
3
|
export { Plugin, createServiceToken } from '@soeditor/core';
|
|
2
4
|
export type { Command, CommandContext, DocumentFormat, Editor, EditorEvents, EditorState, EventListener, PluginConstructor, PluginContext, ServiceCollection, ServiceToken, Transaction, TransactionMetadata, TransactionOptions, TransactionOrigin, } from '@soeditor/core';
|
|
5
|
+
export { mapEditingPoint, readEditingOperations, StructuredEditingContributionAlreadyRegisteredError, StructuredEditingContributionConflictError, StructuredEditingPlugin, StructuredEditingRegistrySealedError, structuredEditingRegistryToken, VisualDecorationsPlugin, visualDecorationsServiceToken, visualEditingServiceToken, } from '@soeditor/engine';
|
|
6
|
+
export type { EditingBlock, EditingModel, EditingOperation, EditingPoint, EditingPointAffinity, EditingSelection, EditingStructuredBlock, EditingStructuredBlockContent, StructuredBlockBehavior, StructuredBlockConversion, StructuredEditingRegistry, StructuredNodeViewActions, StructuredNodeViewContext, StructuredNodeViewFactory, StructuredNodeViewInstance, StructuredNodeViewSelectionOptions, StructuredNodeViewState, VisualBlockTag, VisualDecoration, VisualDecorationsService, VisualDecorationStatus, VisualEditingService, VisualLinkAttributes, VisualTextMark, } from '@soeditor/engine';
|
|
3
7
|
export { DiagnosticsPlugin, diagnosticsServiceToken, } from '@soeditor/html-tools';
|
|
4
|
-
export type { Diagnostic, DiagnosticProvider, DiagnosticsService, Problem, ProblemSeverity, } from '@soeditor/html-tools';
|
|
8
|
+
export type { Diagnostic, DiagnosticCounts, DiagnosticFilter, DiagnosticProvider, DiagnosticProviderFailure, DiagnosticsService, DiagnosticsSnapshot, DiagnosticsStatus, DiagnosticsValidationPolicy, DiagnosticsWorkflowConfig, Problem, ProblemSeverity, } from '@soeditor/html-tools';
|
|
9
|
+
export { SplitViewPlugin, splitViewServiceToken } from '@soeditor/layout';
|
|
10
|
+
export type { SplitOrientation, SplitViewAdapter, SplitViewAttachment, SplitViewPair, SplitViewService, SplitViewSnapshot, } from '@soeditor/layout';
|
|
11
|
+
export { ProjectionCoordinatorPlugin, projectionCoordinatorServiceToken, } from '@soeditor/projections';
|
|
12
|
+
export type { EditableProjectionId, ProjectionActivity, ProjectionAdapter, ProjectionCoordinatorService, ProjectionId, ProjectionSnapshot, } from '@soeditor/projections';
|
|
13
|
+
export { createRevisionsPlugin, revisionsServiceToken, } from '@soeditor/revisions';
|
|
14
|
+
export type { ReviewPolicy, RevisionAction, RevisionAuthor, RevisionDataExport, RevisionKind, RevisionMetadata, RevisionPermissionContext, RevisionPermissionProvider, RevisionProvider, RevisionsPluginOptions, RevisionsService, RevisionsSnapshot, RevisionSnapshot, RevisionStorage, } from '@soeditor/revisions';
|
|
5
15
|
export { fileManagerServiceToken } from '@soeditor/file-manager';
|
|
6
16
|
export type { FileManager, FileManagerKind, FileManagerOpenOptions, FileManagerResult, } from '@soeditor/file-manager';
|
|
7
17
|
export { UiPlugin, uiRegistryServiceToken } from '@soeditor/ui';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAC5D,YAAY,EACR,OAAO,EACP,cAAc,EACd,cAAc,EACd,MAAM,EACN,YAAY,EACZ,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,GACpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACH,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACR,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,OAAO,EACP,eAAe,GAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,YAAY,EACR,WAAW,EACX,eAAe,EACf,sBAAsB,EACtB,iBAAiB,GACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAChE,YAAY,EACR,QAAQ,EACR,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GACpB,MAAM,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAChF,YAAY,EACR,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,wBAAwB,EACxB,yBAAyB,EACzB,YAAY,EACZ,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,aAAa,GAChB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAC5D,YAAY,EACR,OAAO,EACP,cAAc,EACd,cAAc,EACd,MAAM,EACN,YAAY,EACZ,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,GACpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACH,eAAe,EACf,qBAAqB,EACrB,mDAAmD,EACnD,0CAA0C,EAC1C,uBAAuB,EACvB,oCAAoC,EACpC,8BAA8B,EAC9B,uBAAuB,EACvB,6BAA6B,EAC7B,yBAAyB,GAC5B,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EACR,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,6BAA6B,EAC7B,uBAAuB,EACvB,yBAAyB,EACzB,yBAAyB,EACzB,yBAAyB,EACzB,yBAAyB,EACzB,yBAAyB,EACzB,0BAA0B,EAC1B,kCAAkC,EAClC,uBAAuB,EACvB,cAAc,EACd,gBAAgB,EAChB,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,cAAc,GACjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,iBAAiB,EACjB,uBAAuB,GAC1B,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACR,UAAU,EACV,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,yBAAyB,EACzB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,2BAA2B,EAC3B,yBAAyB,EACzB,OAAO,EACP,eAAe,GAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,YAAY,EACR,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACH,2BAA2B,EAC3B,iCAAiC,GACpC,MAAM,uBAAuB,CAAC;AAC/B,YAAY,EACR,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,4BAA4B,EAC5B,YAAY,EACZ,kBAAkB,GACrB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACH,qBAAqB,EACrB,qBAAqB,GACxB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EACR,YAAY,EACZ,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,yBAAyB,EACzB,0BAA0B,EAC1B,gBAAgB,EAChB,sBAAsB,EACtB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,GAClB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,YAAY,EACR,WAAW,EACX,eAAe,EACf,sBAAsB,EACtB,iBAAiB,GACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAChE,YAAY,EACR,QAAQ,EACR,0BAA0B,EAC1B,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GACpB,MAAM,cAAc,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,14 +1,37 @@
|
|
|
1
|
+
import { commentsServiceToken, createCommentsPlugin } from "@soeditor/comments";
|
|
1
2
|
import { Plugin, createServiceToken } from "@soeditor/core";
|
|
3
|
+
import { StructuredEditingContributionAlreadyRegisteredError, StructuredEditingContributionConflictError, StructuredEditingPlugin, StructuredEditingRegistrySealedError, VisualDecorationsPlugin, mapEditingPoint, readEditingOperations, structuredEditingRegistryToken, visualDecorationsServiceToken, visualEditingServiceToken } from "@soeditor/engine";
|
|
2
4
|
import { DiagnosticsPlugin, diagnosticsServiceToken } from "@soeditor/html-tools";
|
|
5
|
+
import { SplitViewPlugin, splitViewServiceToken } from "@soeditor/layout";
|
|
6
|
+
import { ProjectionCoordinatorPlugin, projectionCoordinatorServiceToken } from "@soeditor/projections";
|
|
7
|
+
import { createRevisionsPlugin, revisionsServiceToken } from "@soeditor/revisions";
|
|
3
8
|
import { fileManagerServiceToken } from "@soeditor/file-manager";
|
|
4
9
|
import { UiPlugin, uiRegistryServiceToken } from "@soeditor/ui";
|
|
5
10
|
export {
|
|
6
11
|
DiagnosticsPlugin,
|
|
7
12
|
Plugin,
|
|
13
|
+
ProjectionCoordinatorPlugin,
|
|
14
|
+
SplitViewPlugin,
|
|
15
|
+
StructuredEditingContributionAlreadyRegisteredError,
|
|
16
|
+
StructuredEditingContributionConflictError,
|
|
17
|
+
StructuredEditingPlugin,
|
|
18
|
+
StructuredEditingRegistrySealedError,
|
|
8
19
|
UiPlugin,
|
|
20
|
+
VisualDecorationsPlugin,
|
|
21
|
+
commentsServiceToken,
|
|
22
|
+
createCommentsPlugin,
|
|
23
|
+
createRevisionsPlugin,
|
|
9
24
|
createServiceToken,
|
|
10
25
|
diagnosticsServiceToken,
|
|
11
26
|
fileManagerServiceToken,
|
|
12
|
-
|
|
27
|
+
mapEditingPoint,
|
|
28
|
+
projectionCoordinatorServiceToken,
|
|
29
|
+
readEditingOperations,
|
|
30
|
+
revisionsServiceToken,
|
|
31
|
+
splitViewServiceToken,
|
|
32
|
+
structuredEditingRegistryToken,
|
|
33
|
+
uiRegistryServiceToken,
|
|
34
|
+
visualDecorationsServiceToken,
|
|
35
|
+
visualEditingServiceToken
|
|
13
36
|
};
|
|
14
37
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@soeditor/plugin-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "Stable public extension contracts for SoEditor plugins.",
|
|
6
6
|
"keywords": [
|
|
@@ -37,16 +37,26 @@
|
|
|
37
37
|
}
|
|
38
38
|
},
|
|
39
39
|
"peerDependencies": {
|
|
40
|
-
"@soeditor/core": "0.
|
|
41
|
-
"@soeditor/
|
|
42
|
-
"@soeditor/
|
|
43
|
-
"@soeditor/
|
|
40
|
+
"@soeditor/core": "1.0.0",
|
|
41
|
+
"@soeditor/engine": "1.0.0",
|
|
42
|
+
"@soeditor/layout": "1.0.0",
|
|
43
|
+
"@soeditor/file-manager": "1.0.0",
|
|
44
|
+
"@soeditor/comments": "1.0.0",
|
|
45
|
+
"@soeditor/html-tools": "1.0.0",
|
|
46
|
+
"@soeditor/revisions": "1.0.0",
|
|
47
|
+
"@soeditor/ui": "1.0.0",
|
|
48
|
+
"@soeditor/projections": "1.0.0"
|
|
44
49
|
},
|
|
45
50
|
"devDependencies": {
|
|
46
|
-
"@soeditor/core": "0.
|
|
47
|
-
"@soeditor/
|
|
48
|
-
"@soeditor/file-manager": "0.
|
|
49
|
-
"@soeditor/
|
|
51
|
+
"@soeditor/core": "1.0.0",
|
|
52
|
+
"@soeditor/comments": "1.0.0",
|
|
53
|
+
"@soeditor/file-manager": "1.0.0",
|
|
54
|
+
"@soeditor/layout": "1.0.0",
|
|
55
|
+
"@soeditor/projections": "1.0.0",
|
|
56
|
+
"@soeditor/revisions": "1.0.0",
|
|
57
|
+
"@soeditor/ui": "1.0.0",
|
|
58
|
+
"@soeditor/engine": "1.0.0",
|
|
59
|
+
"@soeditor/html-tools": "1.0.0"
|
|
50
60
|
},
|
|
51
61
|
"scripts": {
|
|
52
62
|
"build": "vite build && tsc -p tsconfig.build.json",
|