@paged-media/plugin-sdk 0.2.24-canary.0 → 0.2.26-canary.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 +373 -0
- package/LICENSE.md +48 -0
- package/dist/index.d.ts +26 -0
- package/dist/index.js +100 -1
- package/package.json +3 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,373 @@
|
|
|
1
|
+
Mozilla Public License Version 2.0
|
|
2
|
+
==================================
|
|
3
|
+
|
|
4
|
+
1. Definitions
|
|
5
|
+
--------------
|
|
6
|
+
|
|
7
|
+
1.1. "Contributor"
|
|
8
|
+
means each individual or legal entity that creates, contributes to
|
|
9
|
+
the creation of, or owns Covered Software.
|
|
10
|
+
|
|
11
|
+
1.2. "Contributor Version"
|
|
12
|
+
means the combination of the Contributions of others (if any) used
|
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
|
14
|
+
|
|
15
|
+
1.3. "Contribution"
|
|
16
|
+
means Covered Software of a particular Contributor.
|
|
17
|
+
|
|
18
|
+
1.4. "Covered Software"
|
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
|
22
|
+
including portions thereof.
|
|
23
|
+
|
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
|
25
|
+
means
|
|
26
|
+
|
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
|
28
|
+
in Exhibit B to the Covered Software; or
|
|
29
|
+
|
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
|
32
|
+
terms of a Secondary License.
|
|
33
|
+
|
|
34
|
+
1.6. "Executable Form"
|
|
35
|
+
means any form of the work other than Source Code Form.
|
|
36
|
+
|
|
37
|
+
1.7. "Larger Work"
|
|
38
|
+
means a work that combines Covered Software with other material, in
|
|
39
|
+
a separate file or files, that is not Covered Software.
|
|
40
|
+
|
|
41
|
+
1.8. "License"
|
|
42
|
+
means this document.
|
|
43
|
+
|
|
44
|
+
1.9. "Licensable"
|
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
|
47
|
+
all of the rights conveyed by this License.
|
|
48
|
+
|
|
49
|
+
1.10. "Modifications"
|
|
50
|
+
means any of the following:
|
|
51
|
+
|
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
|
53
|
+
deletion from, or modification of the contents of Covered
|
|
54
|
+
Software; or
|
|
55
|
+
|
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
|
57
|
+
Software.
|
|
58
|
+
|
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
|
60
|
+
means any patent claim(s), including without limitation, method,
|
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
|
64
|
+
made, import, or transfer of either its Contributions or its
|
|
65
|
+
Contributor Version.
|
|
66
|
+
|
|
67
|
+
1.12. "Secondary License"
|
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
|
71
|
+
licenses.
|
|
72
|
+
|
|
73
|
+
1.13. "Source Code Form"
|
|
74
|
+
means the form of the work preferred for making modifications.
|
|
75
|
+
|
|
76
|
+
1.14. "You" (or "Your")
|
|
77
|
+
means an individual or a legal entity exercising rights under this
|
|
78
|
+
License. For legal entities, "You" includes any entity that
|
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
|
84
|
+
ownership of such entity.
|
|
85
|
+
|
|
86
|
+
2. License Grants and Conditions
|
|
87
|
+
--------------------------------
|
|
88
|
+
|
|
89
|
+
2.1. Grants
|
|
90
|
+
|
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
|
92
|
+
non-exclusive license:
|
|
93
|
+
|
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
|
98
|
+
as part of a Larger Work; and
|
|
99
|
+
|
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
|
102
|
+
Contributions or its Contributor Version.
|
|
103
|
+
|
|
104
|
+
2.2. Effective Date
|
|
105
|
+
|
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
|
108
|
+
distributes such Contribution.
|
|
109
|
+
|
|
110
|
+
2.3. Limitations on Grant Scope
|
|
111
|
+
|
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
|
114
|
+
distribution or licensing of Covered Software under this License.
|
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
|
116
|
+
Contributor:
|
|
117
|
+
|
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
|
119
|
+
or
|
|
120
|
+
|
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
|
123
|
+
Contributions with other software (except as part of its Contributor
|
|
124
|
+
Version); or
|
|
125
|
+
|
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
|
127
|
+
its Contributions.
|
|
128
|
+
|
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
|
131
|
+
the notice requirements in Section 3.4).
|
|
132
|
+
|
|
133
|
+
2.4. Subsequent Licenses
|
|
134
|
+
|
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
|
138
|
+
permitted under the terms of Section 3.3).
|
|
139
|
+
|
|
140
|
+
2.5. Representation
|
|
141
|
+
|
|
142
|
+
Each Contributor represents that the Contributor believes its
|
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
|
145
|
+
|
|
146
|
+
2.6. Fair Use
|
|
147
|
+
|
|
148
|
+
This License is not intended to limit any rights You have under
|
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
|
150
|
+
equivalents.
|
|
151
|
+
|
|
152
|
+
2.7. Conditions
|
|
153
|
+
|
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
|
155
|
+
in Section 2.1.
|
|
156
|
+
|
|
157
|
+
3. Responsibilities
|
|
158
|
+
-------------------
|
|
159
|
+
|
|
160
|
+
3.1. Distribution of Source Form
|
|
161
|
+
|
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
|
168
|
+
Form.
|
|
169
|
+
|
|
170
|
+
3.2. Distribution of Executable Form
|
|
171
|
+
|
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
|
173
|
+
|
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
|
178
|
+
than the cost of distribution to the recipient; and
|
|
179
|
+
|
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
|
181
|
+
License, or sublicense it under different terms, provided that the
|
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
|
184
|
+
|
|
185
|
+
3.3. Distribution of a Larger Work
|
|
186
|
+
|
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
|
188
|
+
provided that You also comply with the requirements of this License for
|
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
|
192
|
+
License permits You to additionally distribute such Covered Software
|
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
|
195
|
+
Software under the terms of either this License or such Secondary
|
|
196
|
+
License(s).
|
|
197
|
+
|
|
198
|
+
3.4. Notices
|
|
199
|
+
|
|
200
|
+
You may not remove or alter the substance of any license notices
|
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
|
205
|
+
|
|
206
|
+
3.5. Application of Additional Terms
|
|
207
|
+
|
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
|
217
|
+
jurisdiction.
|
|
218
|
+
|
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
|
220
|
+
---------------------------------------------------
|
|
221
|
+
|
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
|
223
|
+
License with respect to some or all of the Covered Software due to
|
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
|
226
|
+
describe the limitations and the code they affect. Such description must
|
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
|
231
|
+
|
|
232
|
+
5. Termination
|
|
233
|
+
--------------
|
|
234
|
+
|
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
|
237
|
+
compliant, then the rights granted under this License from a particular
|
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
|
245
|
+
first time You have received notice of non-compliance with this License
|
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
|
247
|
+
Your receipt of the notice.
|
|
248
|
+
|
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
|
254
|
+
2.1 of this License shall terminate.
|
|
255
|
+
|
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
|
258
|
+
have been validly granted by You or Your distributors under this License
|
|
259
|
+
prior to termination shall survive termination.
|
|
260
|
+
|
|
261
|
+
************************************************************************
|
|
262
|
+
* *
|
|
263
|
+
* 6. Disclaimer of Warranty *
|
|
264
|
+
* ------------------------- *
|
|
265
|
+
* *
|
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
|
276
|
+
* authorized under this License except under this disclaimer. *
|
|
277
|
+
* *
|
|
278
|
+
************************************************************************
|
|
279
|
+
|
|
280
|
+
************************************************************************
|
|
281
|
+
* *
|
|
282
|
+
* 7. Limitation of Liability *
|
|
283
|
+
* -------------------------- *
|
|
284
|
+
* *
|
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
|
289
|
+
* special, incidental, or consequential damages of any character *
|
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
|
299
|
+
* limitation may not apply to You. *
|
|
300
|
+
* *
|
|
301
|
+
************************************************************************
|
|
302
|
+
|
|
303
|
+
8. Litigation
|
|
304
|
+
-------------
|
|
305
|
+
|
|
306
|
+
Any litigation relating to this License may be brought only in the
|
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
|
311
|
+
cross-claims or counter-claims.
|
|
312
|
+
|
|
313
|
+
9. Miscellaneous
|
|
314
|
+
----------------
|
|
315
|
+
|
|
316
|
+
This License represents the complete agreement concerning the subject
|
|
317
|
+
matter hereof. If any provision of this License is held to be
|
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
|
320
|
+
that the language of a contract shall be construed against the drafter
|
|
321
|
+
shall not be used to construe this License against a Contributor.
|
|
322
|
+
|
|
323
|
+
10. Versions of the License
|
|
324
|
+
---------------------------
|
|
325
|
+
|
|
326
|
+
10.1. New Versions
|
|
327
|
+
|
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
|
330
|
+
publish new versions of this License. Each version will be given a
|
|
331
|
+
distinguishing version number.
|
|
332
|
+
|
|
333
|
+
10.2. Effect of New Versions
|
|
334
|
+
|
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
|
336
|
+
of the License under which You originally received the Covered Software,
|
|
337
|
+
or under the terms of any subsequent version published by the license
|
|
338
|
+
steward.
|
|
339
|
+
|
|
340
|
+
10.3. Modified Versions
|
|
341
|
+
|
|
342
|
+
If you create software not governed by this License, and you want to
|
|
343
|
+
create a new license for such software, you may create and use a
|
|
344
|
+
modified version of this License if you rename the license and remove
|
|
345
|
+
any references to the name of the license steward (except to note that
|
|
346
|
+
such modified license differs from this License).
|
|
347
|
+
|
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
|
349
|
+
Licenses
|
|
350
|
+
|
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
|
354
|
+
|
|
355
|
+
Exhibit A - Source Code Form License Notice
|
|
356
|
+
-------------------------------------------
|
|
357
|
+
|
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
360
|
+
file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
361
|
+
|
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
|
365
|
+
for such a notice.
|
|
366
|
+
|
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
|
368
|
+
|
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
|
370
|
+
---------------------------------------------------------
|
|
371
|
+
|
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
package/LICENSE.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# License
|
|
2
|
+
|
|
3
|
+
The **paged plugin SDK** (<https://paged.media>) is **dual-licensed**. You may
|
|
4
|
+
use, modify, and distribute it under the terms of **either**:
|
|
5
|
+
|
|
6
|
+
- the **Mozilla Public License, version 2.0** (MPL-2.0) — the open-source
|
|
7
|
+
option; the full text is in [`LICENSE`](./LICENSE); or
|
|
8
|
+
- the **Paged Media Enterprise License** (PMEL) — a commercial option
|
|
9
|
+
available from **And The Next GmbH**.
|
|
10
|
+
|
|
11
|
+
`SPDX-License-Identifier: MPL-2.0 OR LicenseRef-PMEL`
|
|
12
|
+
|
|
13
|
+
The SDK is **MPL — like the engine, and deliberately *not* AGPL like the
|
|
14
|
+
editor**. It's the contract third parties build plugins against, so a permissive
|
|
15
|
+
license lets you license **your** plugin however you want — open, closed, or
|
|
16
|
+
commercial. MPL's copyleft is file-level: only modifications to the SDK's own
|
|
17
|
+
files must be shared back; a larger work (your plugin) may combine them with
|
|
18
|
+
files under other licenses.
|
|
19
|
+
|
|
20
|
+
Source files carry the MPL notice (MPL Exhibit A) in their header; new files
|
|
21
|
+
must include it (copy it from any existing source file, or see
|
|
22
|
+
[`CONTRIBUTING.md`](./CONTRIBUTING.md)).
|
|
23
|
+
|
|
24
|
+
## Mozilla Public License 2.0 (open source)
|
|
25
|
+
|
|
26
|
+
The standard, **unmodified** MPL-2.0 governs — see [`LICENSE`](./LICENSE), or
|
|
27
|
+
obtain a copy at <https://mozilla.org/MPL/2.0/>.
|
|
28
|
+
|
|
29
|
+
## Paged Media Enterprise License (commercial)
|
|
30
|
+
|
|
31
|
+
A commercial license is available from **And The Next GmbH** for users who need
|
|
32
|
+
terms MPL-2.0 does not provide — warranty, indemnification, liability cover,
|
|
33
|
+
support SLAs, patent assurances, and the right to modify the SDK's files without
|
|
34
|
+
MPL-2.0's file-level reciprocity. Contact And The Next GmbH for terms.
|
|
35
|
+
|
|
36
|
+
## Contributions
|
|
37
|
+
|
|
38
|
+
Contributions are accepted under the project's Contributor License Agreement,
|
|
39
|
+
which lets And The Next GmbH distribute them under **both** the MPL-2.0 and the
|
|
40
|
+
Paged Media Enterprise License. See [`CONTRIBUTING.md`](./CONTRIBUTING.md) and
|
|
41
|
+
[`CLA.md`](./CLA.md).
|
|
42
|
+
|
|
43
|
+
## Trademarks
|
|
44
|
+
|
|
45
|
+
`paged`, `paged.media`, and the paged logo are trademarks of And The Next GmbH.
|
|
46
|
+
The MPL grants copyright permissions, not trademark permissions.
|
|
47
|
+
|
|
48
|
+
© And The Next GmbH. All rights reserved except as expressly granted above.
|
package/dist/index.d.ts
CHANGED
|
@@ -192,6 +192,23 @@ interface ClipboardBackend {
|
|
|
192
192
|
read(): Promise<ClipboardPayload | null>;
|
|
193
193
|
write(payload: ClipboardPayload): Promise<void>;
|
|
194
194
|
}
|
|
195
|
+
/**
|
|
196
|
+
* The backend the editor injects to back `host.nativeDocument` (ADR-021 /
|
|
197
|
+
* document-model direction): the isolate-safe replacement for an importer/
|
|
198
|
+
* exporter reaching through `host.editor.client`. It exposes read access to
|
|
199
|
+
* the document's CORE-OWNED native parts (the `paged/core/` MODEL + COMPOSITION
|
|
200
|
+
* parts) plus a `open` that loads a plugin-produced native/importable package
|
|
201
|
+
* as the active document. The SDK adapter owns the capability gate; this
|
|
202
|
+
* backend only does the raw IO. A headless host injects no backend → the reads
|
|
203
|
+
* answer `null`/`[]`, `open` rejects, and `supports("document.readNative@1")` /
|
|
204
|
+
* `supports("document.openNative@1")` are false (the honest no-backend door).
|
|
205
|
+
*/
|
|
206
|
+
interface NativeDocumentBackend {
|
|
207
|
+
readModel(): Promise<Uint8Array | null>;
|
|
208
|
+
readComposition(): Promise<Uint8Array | null>;
|
|
209
|
+
listParts(prefix?: string): Promise<string[]>;
|
|
210
|
+
open(bytes: Uint8Array): Promise<void>;
|
|
211
|
+
}
|
|
195
212
|
/** The SHARED cross-plugin data-provider registry (paged.data §7.1 / D-09). The
|
|
196
213
|
* editor creates ONE (`createDataProviderRegistry`) and injects the SAME
|
|
197
214
|
* instance into every plugin host, so a provider plugin and a consumer plugin
|
|
@@ -305,6 +322,15 @@ interface CreateBundleHostOptions {
|
|
|
305
322
|
* When absent, `read` answers `null` and `write` is a no-op (the honest
|
|
306
323
|
* no-clipboard door). */
|
|
307
324
|
clipboard?: ClipboardBackend;
|
|
325
|
+
/** Host-provided NATIVE-DOCUMENT backend (ADR-021). When present,
|
|
326
|
+
* `host.nativeDocument.readModel/readComposition/listParts` read the
|
|
327
|
+
* document's core-owned `paged/core/` native parts through it (gated on
|
|
328
|
+
* `capabilities.document.readNative`) and `host.nativeDocument.open` loads a
|
|
329
|
+
* plugin-produced package as the active document (gated on
|
|
330
|
+
* `capabilities.document.openNative`); `supports("document.readNative@1")` /
|
|
331
|
+
* `supports("document.openNative@1")` answer true. When absent, the reads
|
|
332
|
+
* answer `null`/`[]` and `open` rejects (the honest no-backend door). */
|
|
333
|
+
nativeDocument?: NativeDocumentBackend;
|
|
308
334
|
/** Host-provided WORKER backend (K-3 / S-07 / I-02). When present,
|
|
309
335
|
* `host.workers.spawn` resolves a declared bundle-relative module +
|
|
310
336
|
* constructs a host-owned `Worker` through it (capability-gated,
|
package/dist/index.js
CHANGED
|
@@ -143,7 +143,11 @@ var HOST_FEATURES = [
|
|
|
143
143
|
// through the wire (no injected source), so it is unconditionally
|
|
144
144
|
// implemented at the pinned canvas-wasm — unlike assets.fonts@1, which
|
|
145
145
|
// stays conditional on the editor's injected byte source.
|
|
146
|
-
"assets.images@1"
|
|
146
|
+
"assets.images@1",
|
|
147
|
+
// .paged container parts door (file-format.md) — the engine (canvas-wasm
|
|
148
|
+
// v51) is the writer, so it is live whenever a bundle runs (the worker
|
|
149
|
+
// handshake guarantees a v51-protocol worker).
|
|
150
|
+
"storage.parts@1"
|
|
147
151
|
];
|
|
148
152
|
var PluginApiNotImplemented = class extends Error {
|
|
149
153
|
constructor(member, pointer) {
|
|
@@ -278,6 +282,8 @@ function createBundleHost(getEditor, manifest, options) {
|
|
|
278
282
|
const caps = manifest.capabilities;
|
|
279
283
|
const declared = manifest.contributes;
|
|
280
284
|
const hasDoc = (dir) => caps?.document?.[dir] !== void 0;
|
|
285
|
+
const hasNativeRead = () => caps?.document?.readNative === true;
|
|
286
|
+
const hasNativeOpen = () => caps?.document?.openNative === true;
|
|
281
287
|
const hasRendering = (s) => caps?.rendering?.includes(s) ?? false;
|
|
282
288
|
const hasAsset = (k) => caps?.assets?.includes(k) ?? false;
|
|
283
289
|
const hasBlobStore = () => caps?.storage?.blob === true;
|
|
@@ -534,6 +540,16 @@ function createBundleHost(getEditor, manifest, options) {
|
|
|
534
540
|
door,
|
|
535
541
|
"capabilities.document.read must be declared"
|
|
536
542
|
);
|
|
543
|
+
const requireNativeRead = (door) => requireDeclared(
|
|
544
|
+
hasNativeRead(),
|
|
545
|
+
door,
|
|
546
|
+
"capabilities.document.readNative must be declared"
|
|
547
|
+
);
|
|
548
|
+
const requireNativeOpen = (door) => requireDeclared(
|
|
549
|
+
hasNativeOpen(),
|
|
550
|
+
door,
|
|
551
|
+
"capabilities.document.openNative must be declared"
|
|
552
|
+
);
|
|
537
553
|
const document = {
|
|
538
554
|
async mutate(mutation) {
|
|
539
555
|
const denied = denyWrite(
|
|
@@ -1125,6 +1141,70 @@ function createBundleHost(getEditor, manifest, options) {
|
|
|
1125
1141
|
return { used: await blobBackend.used(manifest.id), quota: blobQuota };
|
|
1126
1142
|
}
|
|
1127
1143
|
};
|
|
1144
|
+
const partsBase = `paged/${manifest.id}/`;
|
|
1145
|
+
const partsFull = (rel) => {
|
|
1146
|
+
const clean = rel.replace(/^\/+/, "");
|
|
1147
|
+
if (clean.split("/").includes("..")) {
|
|
1148
|
+
throw new Error(`host.parts: path "${rel}" must not contain ".."`);
|
|
1149
|
+
}
|
|
1150
|
+
return partsBase + clean;
|
|
1151
|
+
};
|
|
1152
|
+
const parts = {
|
|
1153
|
+
async write(path, bytes) {
|
|
1154
|
+
const reply = await getEditor().client.send({
|
|
1155
|
+
kind: "writePagedPart",
|
|
1156
|
+
payload: { path: partsFull(path), bytes: Array.from(bytes) }
|
|
1157
|
+
});
|
|
1158
|
+
if (reply.kind !== "pagedPartWritten") {
|
|
1159
|
+
const err = reply.kind === "pagedPartFailed" ? reply.payload.error : `unexpected ${reply.kind}`;
|
|
1160
|
+
throw new Error(`host.parts.write("${path}"): ${err}`);
|
|
1161
|
+
}
|
|
1162
|
+
},
|
|
1163
|
+
async read(path) {
|
|
1164
|
+
const reply = await getEditor().client.send({
|
|
1165
|
+
kind: "readPagedPart",
|
|
1166
|
+
payload: { path: partsFull(path) }
|
|
1167
|
+
});
|
|
1168
|
+
if (reply.kind === "pagedPartRead") {
|
|
1169
|
+
return reply.payload.found ? Uint8Array.from(reply.payload.bytes) : null;
|
|
1170
|
+
}
|
|
1171
|
+
return null;
|
|
1172
|
+
},
|
|
1173
|
+
async list(prefix2 = "") {
|
|
1174
|
+
const reply = await getEditor().client.send({
|
|
1175
|
+
kind: "listPagedParts",
|
|
1176
|
+
payload: { prefix: partsFull(prefix2) }
|
|
1177
|
+
});
|
|
1178
|
+
if (reply.kind !== "pagedPartList") return [];
|
|
1179
|
+
return reply.payload.paths.map(
|
|
1180
|
+
(p) => p.startsWith(partsBase) ? p.slice(partsBase.length) : p
|
|
1181
|
+
);
|
|
1182
|
+
}
|
|
1183
|
+
};
|
|
1184
|
+
const nativeDocBackend = options?.nativeDocument;
|
|
1185
|
+
const nativeDocument = {
|
|
1186
|
+
async readModel() {
|
|
1187
|
+
requireNativeRead("nativeDocument.readModel");
|
|
1188
|
+
return nativeDocBackend ? nativeDocBackend.readModel() : null;
|
|
1189
|
+
},
|
|
1190
|
+
async readComposition() {
|
|
1191
|
+
requireNativeRead("nativeDocument.readComposition");
|
|
1192
|
+
return nativeDocBackend ? nativeDocBackend.readComposition() : null;
|
|
1193
|
+
},
|
|
1194
|
+
async listParts(prefix2) {
|
|
1195
|
+
requireNativeRead("nativeDocument.listParts");
|
|
1196
|
+
return nativeDocBackend ? nativeDocBackend.listParts(prefix2) : [];
|
|
1197
|
+
},
|
|
1198
|
+
async open(bytes) {
|
|
1199
|
+
requireNativeOpen("nativeDocument.open");
|
|
1200
|
+
if (!nativeDocBackend) {
|
|
1201
|
+
throw new Error(
|
|
1202
|
+
'host.nativeDocument.open: the host wired no nativeDocument backend (supports("document.openNative@1") is false; the editor injects one)'
|
|
1203
|
+
);
|
|
1204
|
+
}
|
|
1205
|
+
return nativeDocBackend.open(bytes);
|
|
1206
|
+
}
|
|
1207
|
+
};
|
|
1128
1208
|
const clipboardBackend = options?.clipboard;
|
|
1129
1209
|
const clipboardGate = (door) => {
|
|
1130
1210
|
const grant = clipboardGrant();
|
|
@@ -1361,6 +1441,10 @@ function createBundleHost(getEditor, manifest, options) {
|
|
|
1361
1441
|
if (options?.clipboard) {
|
|
1362
1442
|
featureSet.add("clipboard@1");
|
|
1363
1443
|
}
|
|
1444
|
+
if (options?.nativeDocument) {
|
|
1445
|
+
featureSet.add("document.readNative@1");
|
|
1446
|
+
featureSet.add("document.openNative@1");
|
|
1447
|
+
}
|
|
1364
1448
|
if (options?.workers) {
|
|
1365
1449
|
featureSet.add("workers@1");
|
|
1366
1450
|
}
|
|
@@ -1382,6 +1466,8 @@ function createBundleHost(getEditor, manifest, options) {
|
|
|
1382
1466
|
shell,
|
|
1383
1467
|
storage,
|
|
1384
1468
|
blob,
|
|
1469
|
+
parts,
|
|
1470
|
+
nativeDocument,
|
|
1385
1471
|
network,
|
|
1386
1472
|
dataProviders,
|
|
1387
1473
|
diagnostics,
|
|
@@ -2224,3 +2310,16 @@ export {
|
|
|
2224
2310
|
satisfiesApiVersion,
|
|
2225
2311
|
toDisposable
|
|
2226
2312
|
};
|
|
2313
|
+
/*
|
|
2314
|
+
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
2315
|
+
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
2316
|
+
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
2317
|
+
*
|
|
2318
|
+
* This file is part of paged (https://paged.media) and is additionally
|
|
2319
|
+
* available under the Paged Media Enterprise License (PMEL). Full
|
|
2320
|
+
* copyright and license information is available in LICENSE.md which is
|
|
2321
|
+
* distributed with this source code.
|
|
2322
|
+
*
|
|
2323
|
+
* @copyright Copyright (c) And The Next GmbH
|
|
2324
|
+
* @license MPL-2.0 OR Paged Media Enterprise License (PMEL)
|
|
2325
|
+
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@paged-media/plugin-sdk",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.26-canary.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
}
|
|
12
12
|
},
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@paged-media/plugin-api": "0.2.
|
|
14
|
+
"@paged-media/plugin-api": "0.2.26-canary.0"
|
|
15
15
|
},
|
|
16
16
|
"peerDependencies": {
|
|
17
17
|
"react": "^18.3.0"
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
}
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
|
-
"@paged-media/canvas-wasm": "0.
|
|
25
|
+
"@paged-media/canvas-wasm": "0.51.0",
|
|
26
26
|
"@types/node": "20.19.39",
|
|
27
27
|
"@types/react": "^18.3.12",
|
|
28
28
|
"react": "^18.3.0",
|