@embedpdf/plugin-page-edit 3.0.0-next.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/LICENSE +192 -0
- package/dist/index.cjs +70 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +53 -0
- package/dist/index.d.ts +53 -0
- package/dist/index.js +68 -0
- package/dist/index.js.map +1 -0
- package/package.json +41 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
Copyright 2026 CloudPDF LTD
|
|
2
|
+
|
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use files in this distribution except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
https://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
|
14
|
+
|
|
15
|
+
-----------------------------------------------------------------------
|
|
16
|
+
|
|
17
|
+
Apache License
|
|
18
|
+
Version 2.0, January 2004
|
|
19
|
+
http://www.apache.org/licenses/
|
|
20
|
+
|
|
21
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
22
|
+
|
|
23
|
+
1. Definitions.
|
|
24
|
+
|
|
25
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
26
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
27
|
+
|
|
28
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
29
|
+
the copyright owner that is granting the License.
|
|
30
|
+
|
|
31
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
32
|
+
other entities that control, are controlled by, or are under common
|
|
33
|
+
control with that entity. For the purposes of this definition,
|
|
34
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
35
|
+
direction or management of such entity, whether by contract or
|
|
36
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
37
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
38
|
+
|
|
39
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
40
|
+
exercising permissions granted by this License.
|
|
41
|
+
|
|
42
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
43
|
+
including but not limited to software source code, documentation
|
|
44
|
+
source, and configuration files.
|
|
45
|
+
|
|
46
|
+
"Object" form shall mean any form resulting from mechanical
|
|
47
|
+
transformation or translation of a Source form, including but
|
|
48
|
+
not limited to compiled object code, generated documentation,
|
|
49
|
+
and conversions to other media types.
|
|
50
|
+
|
|
51
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
52
|
+
Object form, made available under the License, as indicated by a
|
|
53
|
+
copyright notice that is included in or attached to the work
|
|
54
|
+
(an example is provided in the Appendix below).
|
|
55
|
+
|
|
56
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
57
|
+
form, that is based on (or derived from) the Work and for which the
|
|
58
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
59
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
60
|
+
of this License, Derivative Works shall not include works that remain
|
|
61
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
62
|
+
the Work and Derivative Works thereof.
|
|
63
|
+
|
|
64
|
+
"Contribution" shall mean any work of authorship, including
|
|
65
|
+
the original version of the Work and any modifications or additions
|
|
66
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
67
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
68
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
69
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
70
|
+
means any form of electronic, verbal, or written communication sent
|
|
71
|
+
to the Licensor or its representatives, including but not limited to
|
|
72
|
+
communication on electronic mailing lists, source code control systems,
|
|
73
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
74
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
75
|
+
excluding communication that is conspicuously marked or otherwise
|
|
76
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
77
|
+
|
|
78
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
79
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
80
|
+
subsequently incorporated within the Work.
|
|
81
|
+
|
|
82
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
83
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
84
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
85
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
86
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
87
|
+
Work and such Derivative Works in Source or Object form.
|
|
88
|
+
|
|
89
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
90
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
91
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
92
|
+
(except as stated in this section) patent license to make, have made,
|
|
93
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
94
|
+
where such license applies only to those patent claims licensable
|
|
95
|
+
by such Contributor that are necessarily infringed by their
|
|
96
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
97
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
98
|
+
institute patent litigation against any entity (including a
|
|
99
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
100
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
101
|
+
or contributory patent infringement, then any patent licenses
|
|
102
|
+
granted to You under this License for that Work shall terminate
|
|
103
|
+
as of the date such litigation is filed.
|
|
104
|
+
|
|
105
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
106
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
107
|
+
modifications, and in Source or Object form, provided that You
|
|
108
|
+
meet the following conditions:
|
|
109
|
+
|
|
110
|
+
(a) You must give any other recipients of the Work or
|
|
111
|
+
Derivative Works a copy of this License; and
|
|
112
|
+
|
|
113
|
+
(b) You must cause any modified files to carry prominent notices
|
|
114
|
+
stating that You changed the files; and
|
|
115
|
+
|
|
116
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
117
|
+
that You distribute, all copyright, patent, trademark, and
|
|
118
|
+
attribution notices from the Source form of the Work,
|
|
119
|
+
excluding those notices that do not pertain to any part of
|
|
120
|
+
the Derivative Works; and
|
|
121
|
+
|
|
122
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
123
|
+
distribution, then any Derivative Works that You distribute must
|
|
124
|
+
include a readable copy of the attribution notices contained
|
|
125
|
+
within such NOTICE file, excluding those notices that do not
|
|
126
|
+
pertain to any part of the Derivative Works, in at least one
|
|
127
|
+
of the following places: within a NOTICE text file distributed
|
|
128
|
+
as part of the Derivative Works; within the Source form or
|
|
129
|
+
documentation, if provided along with the Derivative Works; or,
|
|
130
|
+
within a display generated by the Derivative Works, if and
|
|
131
|
+
wherever such third-party notices normally appear. The contents
|
|
132
|
+
of the NOTICE file are for informational purposes only and
|
|
133
|
+
do not modify the License. You may add Your own attribution
|
|
134
|
+
notices within Derivative Works that You distribute, alongside
|
|
135
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
136
|
+
that such additional attribution notices cannot be construed
|
|
137
|
+
as modifying the License.
|
|
138
|
+
|
|
139
|
+
You may add Your own copyright statement to Your modifications and
|
|
140
|
+
may provide additional or different license terms and conditions
|
|
141
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
142
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
143
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
144
|
+
the conditions stated in this License.
|
|
145
|
+
|
|
146
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
147
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
148
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
149
|
+
this License, without any additional terms or conditions.
|
|
150
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
151
|
+
the terms of any separate license agreement you may have executed
|
|
152
|
+
with Licensor regarding such Contributions.
|
|
153
|
+
|
|
154
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
155
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
156
|
+
except as required for reasonable and customary use in describing the
|
|
157
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
158
|
+
|
|
159
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
160
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
161
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
162
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
163
|
+
implied, including, without limitation, any warranties or conditions
|
|
164
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
165
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
166
|
+
appropriateness of using or redistributing the Work and assume any
|
|
167
|
+
risks associated with Your exercise of permissions under this License.
|
|
168
|
+
|
|
169
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
170
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
171
|
+
unless required by applicable law (such as deliberate and grossly
|
|
172
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
173
|
+
liable to You for damages, including any direct, indirect, special,
|
|
174
|
+
incidental, or consequential damages of any character arising as a
|
|
175
|
+
result of this License or out of the use or inability to use the
|
|
176
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
177
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
178
|
+
other commercial damages or losses), even if such Contributor
|
|
179
|
+
has been advised of the possibility of such damages.
|
|
180
|
+
|
|
181
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
182
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
183
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
184
|
+
or other liability obligations and/or rights consistent with this
|
|
185
|
+
License. However, in accepting such obligations, You may act only
|
|
186
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
187
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
188
|
+
defend, and hold each Contributor harmless for any liability
|
|
189
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
190
|
+
of your accepting any such warranty or additional liability.
|
|
191
|
+
|
|
192
|
+
END OF TERMS AND CONDITIONS
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
+
let _embedpdf_core = require("@embedpdf/core");
|
|
3
|
+
//#region src/capability.ts
|
|
4
|
+
/**
|
|
5
|
+
* Authorization for structural page edits. Maps to PDF bit 11 (ASSEMBLE =
|
|
6
|
+
* insert/rotate/delete pages). The engine ALSO enforces this — every
|
|
7
|
+
* page-structure verb throws `PermissionDenied` without it, identically on
|
|
8
|
+
* local and cloud — so `canEdit()` is the UI mirror of a real guard, not the
|
|
9
|
+
* guard itself. Typed as `DocCapability` so a typo is a compile error.
|
|
10
|
+
*/
|
|
11
|
+
const ASSEMBLE_CAPABILITY = "doc.pages.assemble";
|
|
12
|
+
/**
|
|
13
|
+
* Forwards structural edits to the document's engine handle, addressed by PON.
|
|
14
|
+
* The handle (`ctx.doc`) and the page registry (`ctx.document()`, kept in sync
|
|
15
|
+
* by the kernel's event→registry bridge) are both already on the plugin
|
|
16
|
+
* context — this capability is the thin layer that turns the relative rotate
|
|
17
|
+
* gesture into the engine's absolute wire.
|
|
18
|
+
*/
|
|
19
|
+
function createPageEditCapability(ctx) {
|
|
20
|
+
const requireDoc = () => {
|
|
21
|
+
const doc = ctx.doc;
|
|
22
|
+
if (!doc) throw new Error("[page-edit] no document bound");
|
|
23
|
+
return doc;
|
|
24
|
+
};
|
|
25
|
+
/** Current absolute rotation of a page from the registry; 0 if unknown. */
|
|
26
|
+
const rotationOf = (pon) => {
|
|
27
|
+
return (ctx.document()?.pages.find((p) => p.pageObjectNumber === pon))?.rotation ?? 0;
|
|
28
|
+
};
|
|
29
|
+
return {
|
|
30
|
+
canEdit() {
|
|
31
|
+
return ctx.doc?.security.allows(ASSEMBLE_CAPABILITY) ?? false;
|
|
32
|
+
},
|
|
33
|
+
rotateBy(pon, delta) {
|
|
34
|
+
const next = ((rotationOf(pon) + delta) % 360 + 360) % 360;
|
|
35
|
+
return requireDoc().pages.rotate([pon], next);
|
|
36
|
+
},
|
|
37
|
+
setRotation(pons, rotation) {
|
|
38
|
+
return requireDoc().pages.rotate(pons, rotation);
|
|
39
|
+
},
|
|
40
|
+
move(pons, destIndex) {
|
|
41
|
+
return requireDoc().pages.move(pons, destIndex);
|
|
42
|
+
},
|
|
43
|
+
delete(pons) {
|
|
44
|
+
return requireDoc().pages.delete(pons);
|
|
45
|
+
}
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
//#endregion
|
|
49
|
+
//#region src/types.ts
|
|
50
|
+
const PageEditToken = (0, _embedpdf_core.createCapabilityToken)("page-edit");
|
|
51
|
+
//#endregion
|
|
52
|
+
//#region src/page-edit.plugin.ts
|
|
53
|
+
/**
|
|
54
|
+
* Document-scoped, stateless: turns the engine handle's page service into a
|
|
55
|
+
* PON-addressed edit capability. The relative→absolute rotation lives in the
|
|
56
|
+
* capability so the four framework adapters never re-derive it, and this is the
|
|
57
|
+
* home for client-side edit state (pending/optimistic/undo) when it lands —
|
|
58
|
+
* adapters keep their thin hook over `PageEditToken` unchanged.
|
|
59
|
+
*/
|
|
60
|
+
const pageEditPlugin = () => (0, _embedpdf_core.definePlugin)({
|
|
61
|
+
id: "page-edit",
|
|
62
|
+
scope: "document",
|
|
63
|
+
token: PageEditToken,
|
|
64
|
+
capability: createPageEditCapability
|
|
65
|
+
});
|
|
66
|
+
//#endregion
|
|
67
|
+
exports.PageEditToken = PageEditToken;
|
|
68
|
+
exports.pageEditPlugin = pageEditPlugin;
|
|
69
|
+
|
|
70
|
+
//# sourceMappingURL=index.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.cjs","names":[],"sources":["../src/capability.ts","../src/types.ts","../src/page-edit.plugin.ts"],"sourcesContent":["import type { PluginContext, PageObjectNumber, PageRotation, DocCapability } from '@embedpdf/core';\nimport type { PageEditCapability } from './types';\n\n/**\n * Authorization for structural page edits. Maps to PDF bit 11 (ASSEMBLE =\n * insert/rotate/delete pages). The engine ALSO enforces this — every\n * page-structure verb throws `PermissionDenied` without it, identically on\n * local and cloud — so `canEdit()` is the UI mirror of a real guard, not the\n * guard itself. Typed as `DocCapability` so a typo is a compile error.\n */\nconst ASSEMBLE_CAPABILITY: DocCapability = 'doc.pages.assemble';\n\n/**\n * Forwards structural edits to the document's engine handle, addressed by PON.\n * The handle (`ctx.doc`) and the page registry (`ctx.document()`, kept in sync\n * by the kernel's event→registry bridge) are both already on the plugin\n * context — this capability is the thin layer that turns the relative rotate\n * gesture into the engine's absolute wire.\n */\nexport function createPageEditCapability(ctx: PluginContext<unknown>): PageEditCapability {\n const requireDoc = () => {\n const doc = ctx.doc;\n if (!doc) throw new Error('[page-edit] no document bound');\n return doc;\n };\n\n /** Current absolute rotation of a page from the registry; 0 if unknown. */\n const rotationOf = (pon: PageObjectNumber): PageRotation => {\n const page = ctx.document()?.pages.find((p) => p.pageObjectNumber === pon);\n return page?.rotation ?? 0;\n };\n\n return {\n canEdit() {\n // Wildcard-aware predicate (mirrors the engine's own enforcement),\n // identical on both engines. NOT `effectiveScope.includes(...)` — that\n // enumeration drops the `*` admin grant, so it would hide the UI on a\n // default admin open even though the engine allows the edit.\n return ctx.doc?.security.allows(ASSEMBLE_CAPABILITY) ?? false;\n },\n\n rotateBy(pon, delta) {\n // Wrap to [0, 360) — the double-mod keeps -90 from current 0 landing on 270.\n const next = ((((rotationOf(pon) + delta) % 360) + 360) % 360) as PageRotation;\n return requireDoc().pages.rotate([pon], next);\n },\n\n setRotation(pons, rotation) {\n return requireDoc().pages.rotate(pons, rotation);\n },\n\n move(pons, destIndex) {\n return requireDoc().pages.move(pons, destIndex);\n },\n\n delete(pons) {\n return requireDoc().pages.delete(pons);\n },\n };\n}\n","import {\n createCapabilityToken,\n type AbortablePromise,\n type PageObjectNumber,\n type PageRotation,\n type PageRotateResult,\n type PageMoveResult,\n type PageDeleteResult,\n} from '@embedpdf/core';\n\n/**\n * Structural page edits, addressed by durable PON (never display index — an\n * index shifts the moment a sibling is moved or deleted). Mirrors the engine's\n * `DocumentPagesService` 1:1, with one addition the engine can't have: the\n * relative `rotateBy` gesture. The engine wire is always ABSOLUTE; turning a\n * \"+90° on this thumbnail\" click into an absolute value needs the page's\n * current rotation, so that read+arithmetic lives HERE — once — instead of\n * being re-derived in every framework adapter's click handler.\n *\n * Document-scoped: rotation is shared document metadata, so editing through the\n * sidebar lens and seeing it in the main lens is automatic (both read the same\n * registry, which the kernel keeps in sync from the engine's event stream).\n */\nexport interface PageEditCapability {\n /**\n * Whether this caller is authorized to perform structural page edits —\n * `effectiveScope` includes `doc.pages.assemble` (PDF bit 11). UIs gate their\n * edit affordances on this; the engine independently enforces the same\n * capability and throws `PermissionDenied` if a call slips through.\n */\n canEdit(): boolean;\n\n /**\n * Rotate a SINGLE page by a relative quarter-turn — the per-thumbnail button\n * gesture. Reads the page's current rotation from the registry and forwards\n * the resulting absolute rotation to the engine.\n */\n rotateBy(pon: PageObjectNumber, delta: 90 | -90): AbortablePromise<PageRotateResult>;\n\n /**\n * Set the ABSOLUTE rotation of one or more pages to a single shared value —\n * the multi-select gesture. Maps 1:1 to the engine.\n */\n setRotation(pons: PageObjectNumber[], rotation: PageRotation): AbortablePromise<PageRotateResult>;\n\n /** Reorder pages (by PON) as a contiguous block starting at `destIndex`. */\n move(pons: PageObjectNumber[], destIndex: number): AbortablePromise<PageMoveResult>;\n\n /** Delete pages by PON. The engine rejects deleting every page. */\n delete(pons: PageObjectNumber[]): AbortablePromise<PageDeleteResult>;\n}\n\nexport const PageEditToken = createCapabilityToken<PageEditCapability>('page-edit');\n","import { definePlugin } from '@embedpdf/core';\nimport { createPageEditCapability } from './capability';\nimport { PageEditToken } from './types';\n\n/**\n * Document-scoped, stateless: turns the engine handle's page service into a\n * PON-addressed edit capability. The relative→absolute rotation lives in the\n * capability so the four framework adapters never re-derive it, and this is the\n * home for client-side edit state (pending/optimistic/undo) when it lands —\n * adapters keep their thin hook over `PageEditToken` unchanged.\n */\nexport const pageEditPlugin = () =>\n definePlugin({\n id: 'page-edit',\n scope: 'document',\n token: PageEditToken,\n capability: createPageEditCapability,\n });\n"],"mappings":";;;;;;;;;;AAUA,MAAM,sBAAqC;;;;;;;;AAS3C,SAAgB,yBAAyB,KAAiD;CACxF,MAAM,mBAAmB;EACvB,MAAM,MAAM,IAAI;EAChB,IAAI,CAAC,KAAK,MAAM,IAAI,MAAM,+BAA+B;EACzD,OAAO;CACT;;CAGA,MAAM,cAAc,QAAwC;EAE1D,QADa,IAAI,SAAS,CAAC,EAAE,MAAM,MAAM,MAAM,EAAE,qBAAqB,GAAG,EAAA,EAC5D,YAAY;CAC3B;CAEA,OAAO;EACL,UAAU;GAKR,OAAO,IAAI,KAAK,SAAS,OAAO,mBAAmB,KAAK;EAC1D;EAEA,SAAS,KAAK,OAAO;GAEnB,MAAM,SAAW,WAAW,GAAG,IAAI,SAAS,MAAO,OAAO;GAC1D,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,GAAG,IAAI;EAC9C;EAEA,YAAY,MAAM,UAAU;GAC1B,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,MAAM,QAAQ;EACjD;EAEA,KAAK,MAAM,WAAW;GACpB,OAAO,WAAW,CAAC,CAAC,MAAM,KAAK,MAAM,SAAS;EAChD;EAEA,OAAO,MAAM;GACX,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,IAAI;EACvC;CACF;AACF;;;ACPA,MAAa,iBAAA,GAAA,eAAA,sBAAA,CAA0D,WAAW;;;;;;;;;;ACzClF,MAAa,wBAAA,GAAA,eAAA,aAAA,CACE;CACX,IAAI;CACJ,OAAO;CACP,OAAO;CACP,YAAY;AACd,CAAC"}
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { AbortablePromise, PageDeleteResult, PageMoveResult, PageObjectNumber, PageRotateResult, PageRotation } from "@embedpdf/core";
|
|
2
|
+
//#region src/types.d.ts
|
|
3
|
+
/**
|
|
4
|
+
* Structural page edits, addressed by durable PON (never display index — an
|
|
5
|
+
* index shifts the moment a sibling is moved or deleted). Mirrors the engine's
|
|
6
|
+
* `DocumentPagesService` 1:1, with one addition the engine can't have: the
|
|
7
|
+
* relative `rotateBy` gesture. The engine wire is always ABSOLUTE; turning a
|
|
8
|
+
* "+90° on this thumbnail" click into an absolute value needs the page's
|
|
9
|
+
* current rotation, so that read+arithmetic lives HERE — once — instead of
|
|
10
|
+
* being re-derived in every framework adapter's click handler.
|
|
11
|
+
*
|
|
12
|
+
* Document-scoped: rotation is shared document metadata, so editing through the
|
|
13
|
+
* sidebar lens and seeing it in the main lens is automatic (both read the same
|
|
14
|
+
* registry, which the kernel keeps in sync from the engine's event stream).
|
|
15
|
+
*/
|
|
16
|
+
interface PageEditCapability {
|
|
17
|
+
/**
|
|
18
|
+
* Whether this caller is authorized to perform structural page edits —
|
|
19
|
+
* `effectiveScope` includes `doc.pages.assemble` (PDF bit 11). UIs gate their
|
|
20
|
+
* edit affordances on this; the engine independently enforces the same
|
|
21
|
+
* capability and throws `PermissionDenied` if a call slips through.
|
|
22
|
+
*/
|
|
23
|
+
canEdit(): boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Rotate a SINGLE page by a relative quarter-turn — the per-thumbnail button
|
|
26
|
+
* gesture. Reads the page's current rotation from the registry and forwards
|
|
27
|
+
* the resulting absolute rotation to the engine.
|
|
28
|
+
*/
|
|
29
|
+
rotateBy(pon: PageObjectNumber, delta: 90 | -90): AbortablePromise<PageRotateResult>;
|
|
30
|
+
/**
|
|
31
|
+
* Set the ABSOLUTE rotation of one or more pages to a single shared value —
|
|
32
|
+
* the multi-select gesture. Maps 1:1 to the engine.
|
|
33
|
+
*/
|
|
34
|
+
setRotation(pons: PageObjectNumber[], rotation: PageRotation): AbortablePromise<PageRotateResult>;
|
|
35
|
+
/** Reorder pages (by PON) as a contiguous block starting at `destIndex`. */
|
|
36
|
+
move(pons: PageObjectNumber[], destIndex: number): AbortablePromise<PageMoveResult>;
|
|
37
|
+
/** Delete pages by PON. The engine rejects deleting every page. */
|
|
38
|
+
delete(pons: PageObjectNumber[]): AbortablePromise<PageDeleteResult>;
|
|
39
|
+
}
|
|
40
|
+
declare const PageEditToken: import("@embedpdf/core").CapabilityToken<PageEditCapability>;
|
|
41
|
+
//#endregion
|
|
42
|
+
//#region src/page-edit.plugin.d.ts
|
|
43
|
+
/**
|
|
44
|
+
* Document-scoped, stateless: turns the engine handle's page service into a
|
|
45
|
+
* PON-addressed edit capability. The relative→absolute rotation lives in the
|
|
46
|
+
* capability so the four framework adapters never re-derive it, and this is the
|
|
47
|
+
* home for client-side edit state (pending/optimistic/undo) when it lands —
|
|
48
|
+
* adapters keep their thin hook over `PageEditToken` unchanged.
|
|
49
|
+
*/
|
|
50
|
+
declare const pageEditPlugin: () => import("@embedpdf/core").PluginDef<unknown, import("@embedpdf/core").Action, PageEditCapability>;
|
|
51
|
+
//#endregion
|
|
52
|
+
export { type PageEditCapability, PageEditToken, pageEditPlugin };
|
|
53
|
+
//# sourceMappingURL=index.d.cts.map
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { AbortablePromise, PageDeleteResult, PageMoveResult, PageObjectNumber, PageRotateResult, PageRotation } from "@embedpdf/core";
|
|
2
|
+
//#region src/types.d.ts
|
|
3
|
+
/**
|
|
4
|
+
* Structural page edits, addressed by durable PON (never display index — an
|
|
5
|
+
* index shifts the moment a sibling is moved or deleted). Mirrors the engine's
|
|
6
|
+
* `DocumentPagesService` 1:1, with one addition the engine can't have: the
|
|
7
|
+
* relative `rotateBy` gesture. The engine wire is always ABSOLUTE; turning a
|
|
8
|
+
* "+90° on this thumbnail" click into an absolute value needs the page's
|
|
9
|
+
* current rotation, so that read+arithmetic lives HERE — once — instead of
|
|
10
|
+
* being re-derived in every framework adapter's click handler.
|
|
11
|
+
*
|
|
12
|
+
* Document-scoped: rotation is shared document metadata, so editing through the
|
|
13
|
+
* sidebar lens and seeing it in the main lens is automatic (both read the same
|
|
14
|
+
* registry, which the kernel keeps in sync from the engine's event stream).
|
|
15
|
+
*/
|
|
16
|
+
interface PageEditCapability {
|
|
17
|
+
/**
|
|
18
|
+
* Whether this caller is authorized to perform structural page edits —
|
|
19
|
+
* `effectiveScope` includes `doc.pages.assemble` (PDF bit 11). UIs gate their
|
|
20
|
+
* edit affordances on this; the engine independently enforces the same
|
|
21
|
+
* capability and throws `PermissionDenied` if a call slips through.
|
|
22
|
+
*/
|
|
23
|
+
canEdit(): boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Rotate a SINGLE page by a relative quarter-turn — the per-thumbnail button
|
|
26
|
+
* gesture. Reads the page's current rotation from the registry and forwards
|
|
27
|
+
* the resulting absolute rotation to the engine.
|
|
28
|
+
*/
|
|
29
|
+
rotateBy(pon: PageObjectNumber, delta: 90 | -90): AbortablePromise<PageRotateResult>;
|
|
30
|
+
/**
|
|
31
|
+
* Set the ABSOLUTE rotation of one or more pages to a single shared value —
|
|
32
|
+
* the multi-select gesture. Maps 1:1 to the engine.
|
|
33
|
+
*/
|
|
34
|
+
setRotation(pons: PageObjectNumber[], rotation: PageRotation): AbortablePromise<PageRotateResult>;
|
|
35
|
+
/** Reorder pages (by PON) as a contiguous block starting at `destIndex`. */
|
|
36
|
+
move(pons: PageObjectNumber[], destIndex: number): AbortablePromise<PageMoveResult>;
|
|
37
|
+
/** Delete pages by PON. The engine rejects deleting every page. */
|
|
38
|
+
delete(pons: PageObjectNumber[]): AbortablePromise<PageDeleteResult>;
|
|
39
|
+
}
|
|
40
|
+
declare const PageEditToken: import("@embedpdf/core").CapabilityToken<PageEditCapability>;
|
|
41
|
+
//#endregion
|
|
42
|
+
//#region src/page-edit.plugin.d.ts
|
|
43
|
+
/**
|
|
44
|
+
* Document-scoped, stateless: turns the engine handle's page service into a
|
|
45
|
+
* PON-addressed edit capability. The relative→absolute rotation lives in the
|
|
46
|
+
* capability so the four framework adapters never re-derive it, and this is the
|
|
47
|
+
* home for client-side edit state (pending/optimistic/undo) when it lands —
|
|
48
|
+
* adapters keep their thin hook over `PageEditToken` unchanged.
|
|
49
|
+
*/
|
|
50
|
+
declare const pageEditPlugin: () => import("@embedpdf/core").PluginDef<unknown, import("@embedpdf/core").Action, PageEditCapability>;
|
|
51
|
+
//#endregion
|
|
52
|
+
export { type PageEditCapability, PageEditToken, pageEditPlugin };
|
|
53
|
+
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { createCapabilityToken, definePlugin } from "@embedpdf/core";
|
|
2
|
+
//#region src/capability.ts
|
|
3
|
+
/**
|
|
4
|
+
* Authorization for structural page edits. Maps to PDF bit 11 (ASSEMBLE =
|
|
5
|
+
* insert/rotate/delete pages). The engine ALSO enforces this — every
|
|
6
|
+
* page-structure verb throws `PermissionDenied` without it, identically on
|
|
7
|
+
* local and cloud — so `canEdit()` is the UI mirror of a real guard, not the
|
|
8
|
+
* guard itself. Typed as `DocCapability` so a typo is a compile error.
|
|
9
|
+
*/
|
|
10
|
+
const ASSEMBLE_CAPABILITY = "doc.pages.assemble";
|
|
11
|
+
/**
|
|
12
|
+
* Forwards structural edits to the document's engine handle, addressed by PON.
|
|
13
|
+
* The handle (`ctx.doc`) and the page registry (`ctx.document()`, kept in sync
|
|
14
|
+
* by the kernel's event→registry bridge) are both already on the plugin
|
|
15
|
+
* context — this capability is the thin layer that turns the relative rotate
|
|
16
|
+
* gesture into the engine's absolute wire.
|
|
17
|
+
*/
|
|
18
|
+
function createPageEditCapability(ctx) {
|
|
19
|
+
const requireDoc = () => {
|
|
20
|
+
const doc = ctx.doc;
|
|
21
|
+
if (!doc) throw new Error("[page-edit] no document bound");
|
|
22
|
+
return doc;
|
|
23
|
+
};
|
|
24
|
+
/** Current absolute rotation of a page from the registry; 0 if unknown. */
|
|
25
|
+
const rotationOf = (pon) => {
|
|
26
|
+
return (ctx.document()?.pages.find((p) => p.pageObjectNumber === pon))?.rotation ?? 0;
|
|
27
|
+
};
|
|
28
|
+
return {
|
|
29
|
+
canEdit() {
|
|
30
|
+
return ctx.doc?.security.allows(ASSEMBLE_CAPABILITY) ?? false;
|
|
31
|
+
},
|
|
32
|
+
rotateBy(pon, delta) {
|
|
33
|
+
const next = ((rotationOf(pon) + delta) % 360 + 360) % 360;
|
|
34
|
+
return requireDoc().pages.rotate([pon], next);
|
|
35
|
+
},
|
|
36
|
+
setRotation(pons, rotation) {
|
|
37
|
+
return requireDoc().pages.rotate(pons, rotation);
|
|
38
|
+
},
|
|
39
|
+
move(pons, destIndex) {
|
|
40
|
+
return requireDoc().pages.move(pons, destIndex);
|
|
41
|
+
},
|
|
42
|
+
delete(pons) {
|
|
43
|
+
return requireDoc().pages.delete(pons);
|
|
44
|
+
}
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
//#endregion
|
|
48
|
+
//#region src/types.ts
|
|
49
|
+
const PageEditToken = createCapabilityToken("page-edit");
|
|
50
|
+
//#endregion
|
|
51
|
+
//#region src/page-edit.plugin.ts
|
|
52
|
+
/**
|
|
53
|
+
* Document-scoped, stateless: turns the engine handle's page service into a
|
|
54
|
+
* PON-addressed edit capability. The relative→absolute rotation lives in the
|
|
55
|
+
* capability so the four framework adapters never re-derive it, and this is the
|
|
56
|
+
* home for client-side edit state (pending/optimistic/undo) when it lands —
|
|
57
|
+
* adapters keep their thin hook over `PageEditToken` unchanged.
|
|
58
|
+
*/
|
|
59
|
+
const pageEditPlugin = () => definePlugin({
|
|
60
|
+
id: "page-edit",
|
|
61
|
+
scope: "document",
|
|
62
|
+
token: PageEditToken,
|
|
63
|
+
capability: createPageEditCapability
|
|
64
|
+
});
|
|
65
|
+
//#endregion
|
|
66
|
+
export { PageEditToken, pageEditPlugin };
|
|
67
|
+
|
|
68
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/capability.ts","../src/types.ts","../src/page-edit.plugin.ts"],"sourcesContent":["import type { PluginContext, PageObjectNumber, PageRotation, DocCapability } from '@embedpdf/core';\nimport type { PageEditCapability } from './types';\n\n/**\n * Authorization for structural page edits. Maps to PDF bit 11 (ASSEMBLE =\n * insert/rotate/delete pages). The engine ALSO enforces this — every\n * page-structure verb throws `PermissionDenied` without it, identically on\n * local and cloud — so `canEdit()` is the UI mirror of a real guard, not the\n * guard itself. Typed as `DocCapability` so a typo is a compile error.\n */\nconst ASSEMBLE_CAPABILITY: DocCapability = 'doc.pages.assemble';\n\n/**\n * Forwards structural edits to the document's engine handle, addressed by PON.\n * The handle (`ctx.doc`) and the page registry (`ctx.document()`, kept in sync\n * by the kernel's event→registry bridge) are both already on the plugin\n * context — this capability is the thin layer that turns the relative rotate\n * gesture into the engine's absolute wire.\n */\nexport function createPageEditCapability(ctx: PluginContext<unknown>): PageEditCapability {\n const requireDoc = () => {\n const doc = ctx.doc;\n if (!doc) throw new Error('[page-edit] no document bound');\n return doc;\n };\n\n /** Current absolute rotation of a page from the registry; 0 if unknown. */\n const rotationOf = (pon: PageObjectNumber): PageRotation => {\n const page = ctx.document()?.pages.find((p) => p.pageObjectNumber === pon);\n return page?.rotation ?? 0;\n };\n\n return {\n canEdit() {\n // Wildcard-aware predicate (mirrors the engine's own enforcement),\n // identical on both engines. NOT `effectiveScope.includes(...)` — that\n // enumeration drops the `*` admin grant, so it would hide the UI on a\n // default admin open even though the engine allows the edit.\n return ctx.doc?.security.allows(ASSEMBLE_CAPABILITY) ?? false;\n },\n\n rotateBy(pon, delta) {\n // Wrap to [0, 360) — the double-mod keeps -90 from current 0 landing on 270.\n const next = ((((rotationOf(pon) + delta) % 360) + 360) % 360) as PageRotation;\n return requireDoc().pages.rotate([pon], next);\n },\n\n setRotation(pons, rotation) {\n return requireDoc().pages.rotate(pons, rotation);\n },\n\n move(pons, destIndex) {\n return requireDoc().pages.move(pons, destIndex);\n },\n\n delete(pons) {\n return requireDoc().pages.delete(pons);\n },\n };\n}\n","import {\n createCapabilityToken,\n type AbortablePromise,\n type PageObjectNumber,\n type PageRotation,\n type PageRotateResult,\n type PageMoveResult,\n type PageDeleteResult,\n} from '@embedpdf/core';\n\n/**\n * Structural page edits, addressed by durable PON (never display index — an\n * index shifts the moment a sibling is moved or deleted). Mirrors the engine's\n * `DocumentPagesService` 1:1, with one addition the engine can't have: the\n * relative `rotateBy` gesture. The engine wire is always ABSOLUTE; turning a\n * \"+90° on this thumbnail\" click into an absolute value needs the page's\n * current rotation, so that read+arithmetic lives HERE — once — instead of\n * being re-derived in every framework adapter's click handler.\n *\n * Document-scoped: rotation is shared document metadata, so editing through the\n * sidebar lens and seeing it in the main lens is automatic (both read the same\n * registry, which the kernel keeps in sync from the engine's event stream).\n */\nexport interface PageEditCapability {\n /**\n * Whether this caller is authorized to perform structural page edits —\n * `effectiveScope` includes `doc.pages.assemble` (PDF bit 11). UIs gate their\n * edit affordances on this; the engine independently enforces the same\n * capability and throws `PermissionDenied` if a call slips through.\n */\n canEdit(): boolean;\n\n /**\n * Rotate a SINGLE page by a relative quarter-turn — the per-thumbnail button\n * gesture. Reads the page's current rotation from the registry and forwards\n * the resulting absolute rotation to the engine.\n */\n rotateBy(pon: PageObjectNumber, delta: 90 | -90): AbortablePromise<PageRotateResult>;\n\n /**\n * Set the ABSOLUTE rotation of one or more pages to a single shared value —\n * the multi-select gesture. Maps 1:1 to the engine.\n */\n setRotation(pons: PageObjectNumber[], rotation: PageRotation): AbortablePromise<PageRotateResult>;\n\n /** Reorder pages (by PON) as a contiguous block starting at `destIndex`. */\n move(pons: PageObjectNumber[], destIndex: number): AbortablePromise<PageMoveResult>;\n\n /** Delete pages by PON. The engine rejects deleting every page. */\n delete(pons: PageObjectNumber[]): AbortablePromise<PageDeleteResult>;\n}\n\nexport const PageEditToken = createCapabilityToken<PageEditCapability>('page-edit');\n","import { definePlugin } from '@embedpdf/core';\nimport { createPageEditCapability } from './capability';\nimport { PageEditToken } from './types';\n\n/**\n * Document-scoped, stateless: turns the engine handle's page service into a\n * PON-addressed edit capability. The relative→absolute rotation lives in the\n * capability so the four framework adapters never re-derive it, and this is the\n * home for client-side edit state (pending/optimistic/undo) when it lands —\n * adapters keep their thin hook over `PageEditToken` unchanged.\n */\nexport const pageEditPlugin = () =>\n definePlugin({\n id: 'page-edit',\n scope: 'document',\n token: PageEditToken,\n capability: createPageEditCapability,\n });\n"],"mappings":";;;;;;;;;AAUA,MAAM,sBAAqC;;;;;;;;AAS3C,SAAgB,yBAAyB,KAAiD;CACxF,MAAM,mBAAmB;EACvB,MAAM,MAAM,IAAI;EAChB,IAAI,CAAC,KAAK,MAAM,IAAI,MAAM,+BAA+B;EACzD,OAAO;CACT;;CAGA,MAAM,cAAc,QAAwC;EAE1D,QADa,IAAI,SAAS,CAAC,EAAE,MAAM,MAAM,MAAM,EAAE,qBAAqB,GAAG,EAAA,EAC5D,YAAY;CAC3B;CAEA,OAAO;EACL,UAAU;GAKR,OAAO,IAAI,KAAK,SAAS,OAAO,mBAAmB,KAAK;EAC1D;EAEA,SAAS,KAAK,OAAO;GAEnB,MAAM,SAAW,WAAW,GAAG,IAAI,SAAS,MAAO,OAAO;GAC1D,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,GAAG,IAAI;EAC9C;EAEA,YAAY,MAAM,UAAU;GAC1B,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,MAAM,QAAQ;EACjD;EAEA,KAAK,MAAM,WAAW;GACpB,OAAO,WAAW,CAAC,CAAC,MAAM,KAAK,MAAM,SAAS;EAChD;EAEA,OAAO,MAAM;GACX,OAAO,WAAW,CAAC,CAAC,MAAM,OAAO,IAAI;EACvC;CACF;AACF;;;ACPA,MAAa,gBAAgB,sBAA0C,WAAW;;;;;;;;;;ACzClF,MAAa,uBACX,aAAa;CACX,IAAI;CACJ,OAAO;CACP,OAAO;CACP,YAAY;AACd,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@embedpdf/plugin-page-edit",
|
|
3
|
+
"version": "3.0.0-next.0",
|
|
4
|
+
"private": false,
|
|
5
|
+
"description": "Document-scoped page-edit capability: PON-addressed rotate/move/delete over the engine DocumentHandle. Owns relative→absolute rotation so framework adapters never re-derive it; the home for pending/undo/gating state.",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"main": "./dist/index.js",
|
|
8
|
+
"module": "./dist/index.js",
|
|
9
|
+
"types": "./dist/index.d.ts",
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"import": "./dist/index.js",
|
|
13
|
+
"require": "./dist/index.cjs"
|
|
14
|
+
},
|
|
15
|
+
"./package.json": "./package.json"
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"dist"
|
|
19
|
+
],
|
|
20
|
+
"dependencies": {
|
|
21
|
+
"@embedpdf/core": "3.0.0-next.0"
|
|
22
|
+
},
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"typescript": "^5.0.0",
|
|
25
|
+
"vitest": "^2.1.9",
|
|
26
|
+
"@embedpdf/tooling-build": "0.0.0"
|
|
27
|
+
},
|
|
28
|
+
"license": "Apache-2.0",
|
|
29
|
+
"sideEffects": false,
|
|
30
|
+
"repository": {
|
|
31
|
+
"type": "git",
|
|
32
|
+
"url": "git+https://github.com/embedpdf/embed-pdf-viewer.git",
|
|
33
|
+
"directory": "packages/plugin/page-edit"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"build": "epdf-build",
|
|
37
|
+
"clean": "rimraf dist",
|
|
38
|
+
"typecheck": "tsc -p tsconfig.json --noEmit",
|
|
39
|
+
"test": "vitest run"
|
|
40
|
+
}
|
|
41
|
+
}
|