Release EPUB Tools 0.1.0
This commit is contained in:
@@ -0,0 +1,9 @@
|
|||||||
|
node_modules/
|
||||||
|
dist/
|
||||||
|
release/*.zip
|
||||||
|
release/*.zip.sha256
|
||||||
|
coverage/
|
||||||
|
playwright-report/
|
||||||
|
test-results/
|
||||||
|
*.tsbuildinfo
|
||||||
|
.DS_Store
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
@add-ideas:registry=https://git.add-ideas.de/api/packages/lotobo/npm/
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 0.1.0 - 2026-09-01
|
||||||
|
|
||||||
|
- Added the initial local-first EPUB Tools workbench.
|
||||||
|
- Added EPUB 2/3 package, metadata, manifest, spine, navigation and NCX inspection.
|
||||||
|
- Added bounded link/structure validation and a sandboxed, sanitized, script-free reader with local images.
|
||||||
|
- Added metadata, package-tree, validation, cover, plain-text and sanitized-chapter exports.
|
||||||
|
- Added Dublin Core and declared-cover editing plus normalized EPUB rebuilding.
|
||||||
|
- Added strict path, size, entry-count, ratio, XML/entity, encryption and active-content policies.
|
||||||
|
- Added Toolbox integration, offline shell, deterministic release packaging, unit fixtures and real cross-browser EPUB workflow tests.
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
Run `npm ci`, `npm run check`, and `npm run test:browser` before proposing a change. Keep processing local, preserve explicit limits, and include fixtures for every parser boundary.
|
||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Licences
|
||||||
|
|
||||||
|
The application is GPL-3.0-or-later. Generated release artifacts include an exact runtime dependency licence inventory in `npm-runtime-licenses.txt`.
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
# EPUB Tools
|
||||||
|
|
||||||
|
EPUB Tools is a standalone, local-first EPUB 2/3 reader and publication workbench for the [add·ideas Toolbox](https://git.add-ideas.de/lotobo/toolbox-portal). Books are opened from a browser `File`; no upload, account, analytics, or server-side conversion is involved.
|
||||||
|
|
||||||
|
## Version 0.1.0
|
||||||
|
|
||||||
|
- Opens strict ZIP-based EPUB containers and parses `container.xml`, OPF metadata, manifest, spine, EPUB 3 navigation documents, and EPUB 2 NCX navigation.
|
||||||
|
- Shows a reading-order sidebar and renders XHTML/HTML/SVG content in a sandboxed, script-free iframe. Local images are resolved to temporary object URLs.
|
||||||
|
- Inventories the package and checks required metadata, mimetype ordering/compression, manifest/spine targets, navigation, active content, external resources, missing relative links, hidden entries, encryption metadata, and signatures.
|
||||||
|
- Edits common Dublin Core fields, replaces an existing declared JPEG/PNG/WebP/SVG cover, exports metadata/report/tree JSON, extracts the cover, exports reading-order text, and downloads sanitized chapters.
|
||||||
|
- Rebuilds a fresh EPUB with the uncompressed mimetype first, sorted paths, optional normalized timestamps, updated OPF metadata, and an optional replacement cover.
|
||||||
|
|
||||||
|
The validator is a focused preflight, not a browser port of EPUBCheck. Version 0.1 does not claim complete schema, CSS, accessibility, media-overlay, signature, DRM, or font-licence validation. DRM is detected and reported; it is never bypassed. Rebuilds are disabled when encryption metadata is present and invalidate existing signatures.
|
||||||
|
|
||||||
|
## Safety limits
|
||||||
|
|
||||||
|
- 512 MiB source file, 20,000 entries, 1 GiB declared expanded total
|
||||||
|
- 64 MiB per resource, 500:1 maximum declared expansion ratio
|
||||||
|
- 16 MiB package/chapter parse limit
|
||||||
|
- Link validation scans at most 500 content documents and 32 MiB total, with every skipped scope disclosed
|
||||||
|
- Reader image resolution is capped at 25 MiB per image; plain-text export at 32 MiB
|
||||||
|
- Absolute, backslash, drive-letter, NUL, and parent-traversal archive paths are rejected
|
||||||
|
|
||||||
|
DTD/entity declarations, ZIP encryption, scripts, forms, frames, objects, external reader resources, navigation, stylesheet links, CSS imports/URLs, and event handlers are blocked or removed from the reader surface. Rendering still depends on the current browser and installed fonts.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
Requires Node.js 22 and npm 11.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm ci
|
||||||
|
npm run check
|
||||||
|
npm run test:browser
|
||||||
|
```
|
||||||
|
|
||||||
|
`npm run release:artifact` creates `release/epub-tools-0.1.0.zip` and its SHA-256 sidecar.
|
||||||
|
|
||||||
|
## Licence
|
||||||
|
|
||||||
|
GPL-3.0-or-later. Runtime dependencies retain their own licences; see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
Please report vulnerabilities privately to the repository owner. Do not attach sensitive source files to public issues. Imported inputs are untrusted; parsers must remain bounded and must not execute active content or fetch external resources.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Corresponding source
|
||||||
|
|
||||||
|
The corresponding source for EPUB Tools 0.1.0 is available at:
|
||||||
|
|
||||||
|
https://git.add-ideas.de/lotobo/epub-tools/src/tag/v0.1.0
|
||||||
|
|
||||||
|
Build with Node.js 22, npm 11, `npm ci`, and `npm run release:artifact`.
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# Third-party notices
|
||||||
|
|
||||||
|
Production release inventories reproduce exact dependency licence texts under `LICENSES/npm-runtime-licenses.txt`.
|
||||||
|
|
||||||
|
- `@zip.js/zip.js` 2.9.0 — BSD-3-Clause — bounded ZIP reading and EPUB rebuilding.
|
||||||
|
- `dompurify` 3.4.14 — MPL-2.0 OR Apache-2.0 — active-content sanitization before sandboxed rendering.
|
||||||
|
- Toolbox contract, shell, and test packages 0.2.3 — Apache-2.0.
|
||||||
|
- `@add-ideas/toolbox-helpers` 0.1.0 — GPL-3.0-or-later — bounded decoding, filenames, and browser downloads.
|
||||||
|
- React and React DOM 19.2.8 — MIT.
|
||||||
|
|
||||||
|
EPUB publications opened by a user are not bundled and retain their own copyright and licence terms.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# Accessibility
|
||||||
|
|
||||||
|
The application uses labelled file inputs, fields, tabs, status/error regions, keyboard-operable chapter and action buttons, visible focus indicators, responsive layouts, and scrollable tables/readers. The iframe has a chapter-specific accessible title.
|
||||||
|
|
||||||
|
Reader sanitization can remove scripted or form-based interactions by design. EPUB-internal navigation is disabled in v0.1; the Toolbox reading-order sidebar remains keyboard accessible. Publisher content can itself have poor semantics, contrast, directionality, alt text, or reading order. The safe reader does not certify EPUB accessibility and its fallback stylesheet may change publisher presentation.
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Architecture
|
||||||
|
|
||||||
|
The app is a relocatable static React application using the Toolbox shell and contract. EPUB work is divided into small TypeScript modules under `src/epub/`:
|
||||||
|
|
||||||
|
- `archive.ts` applies ZIP/path/entry/ratio limits and opens the container with zip.js.
|
||||||
|
- `xml.ts`, `package.ts`, and `paths.ts` decode bounded XML, reject DTD/entity input, parse OPF/navigation/NCX, and resolve package-relative references without traversal.
|
||||||
|
- `validation.ts` performs bounded package and cross-document diagnostics and reports skipped scope.
|
||||||
|
- `reader.ts` sanitizes content with DOMPurify, neutralizes navigation and CSS URLs, resolves bounded local images, injects a restrictive iframe CSP, and returns object URLs with an explicit revocation lifecycle.
|
||||||
|
- `export.ts` patches Dublin Core metadata and streams entries into a fresh normalized EPUB. It also produces JSON, cover, chapter, and reading-order text exports.
|
||||||
|
|
||||||
|
zip.js receives a lazy browser `BlobReader`, performs CRC checks when entry data is read, and can use web workers. React retains one open reader and closes the previous reader when a new book replaces it. The original File is immutable; all changes exist only in staged React state or a newly downloaded Blob.
|
||||||
|
|
||||||
|
The safe reader uses both sanitization and an iframe without sandbox permissions. Its `srcdoc` adds `default-src 'none'` and permits only inline styles plus local data/blob image/font/media URLs. Publisher stylesheet links are intentionally removed in v0.1.
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Privacy and security
|
||||||
|
|
||||||
|
All source and generated publication data remains in the browser. The app has no telemetry, account, analytics, remote font, CDN, or default network integration. The production CSP keeps `connect-src` and worker sources same-origin.
|
||||||
|
|
||||||
|
EPUB input is adversarial. Before extraction the app enforces file, entry, expanded-size, per-entry, expansion-ratio, duplicate-name, and path rules. Required XML is size-bounded, supports UTF-8/UTF-16, and rejects DTD/entity declarations. ZIP-encrypted entries cannot be read. `META-INF/encryption.xml` is reported because it can describe valid font obfuscation or DRM; the app does not distinguish every scheme and never attempts circumvention.
|
||||||
|
|
||||||
|
Content documents are never mounted into the application DOM. DOMPurify removes active elements and event handlers, navigation and resource references are neutralized or replaced with bounded local object URLs, and rendering happens inside a permissionless sandboxed iframe with its own restrictive CSP. Temporary object URLs are revoked when chapters change.
|
||||||
|
|
||||||
|
Validation is intentionally bounded and incomplete. It does not establish publication safety, conformance, accessibility, authenticity, ownership, or freedom from hidden data. Reports identify the checks performed and relevant unsupported areas. Rebuilding changes compressed bytes and invalidates signatures; it is disabled for encrypted publications.
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import js from "@eslint/js";
|
||||||
|
import globals from "globals";
|
||||||
|
import reactHooks from "eslint-plugin-react-hooks";
|
||||||
|
import reactRefresh from "eslint-plugin-react-refresh";
|
||||||
|
import tseslint from "typescript-eslint";
|
||||||
|
|
||||||
|
export default tseslint.config(
|
||||||
|
{
|
||||||
|
ignores: [
|
||||||
|
"dist",
|
||||||
|
"release",
|
||||||
|
"coverage",
|
||||||
|
"test-results",
|
||||||
|
"playwright-report",
|
||||||
|
],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
extends: [js.configs.recommended, ...tseslint.configs.recommended],
|
||||||
|
files: ["**/*.{ts,tsx}"],
|
||||||
|
languageOptions: {
|
||||||
|
ecmaVersion: 2023,
|
||||||
|
globals: { ...globals.browser, ...globals.worker },
|
||||||
|
},
|
||||||
|
plugins: { "react-hooks": reactHooks, "react-refresh": reactRefresh },
|
||||||
|
rules: {
|
||||||
|
...reactHooks.configs.recommended.rules,
|
||||||
|
"react-refresh/only-export-components": [
|
||||||
|
"warn",
|
||||||
|
{ allowConstantExport: true },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: ["scripts/**/*.mjs", "playwright.config.ts"],
|
||||||
|
languageOptions: { globals: globals.node },
|
||||||
|
},
|
||||||
|
);
|
||||||
+19
@@ -0,0 +1,19 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<meta
|
||||||
|
name="description"
|
||||||
|
content="Read, inspect and repair EPUB publications locally in the browser."
|
||||||
|
/>
|
||||||
|
<link rel="icon" type="image/svg+xml" href="./favicon.svg" />
|
||||||
|
<link rel="manifest" href="./manifest.webmanifest" />
|
||||||
|
<meta name="theme-color" content="#29255f" />
|
||||||
|
<title>EPUB Tools</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="root"></div>
|
||||||
|
<script type="module" src="./src/main.tsx"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Generated
+3525
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,73 @@
|
|||||||
|
{
|
||||||
|
"name": "epub-tools",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Read, inspect and repair EPUB publications locally in the browser.",
|
||||||
|
"license": "GPL-3.0-or-later",
|
||||||
|
"author": "Albrecht Degering",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://git.add-ideas.de/lotobo/epub-tools.git"
|
||||||
|
},
|
||||||
|
"homepage": "https://git.add-ideas.de/lotobo/epub-tools",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://git.add-ideas.de/lotobo/epub-tools/issues"
|
||||||
|
},
|
||||||
|
"private": true,
|
||||||
|
"type": "module",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=22"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"predev": "npm run manifest:generate",
|
||||||
|
"dev": "vite",
|
||||||
|
"prebuild": "npm run release:prepare && npm run manifest:generate",
|
||||||
|
"build": "tsc -b && vite build",
|
||||||
|
"preview": "vite preview",
|
||||||
|
"typecheck": "tsc -b --pretty false",
|
||||||
|
"lint": "eslint . --max-warnings=0",
|
||||||
|
"format": "prettier --write .",
|
||||||
|
"format:check": "prettier --check .",
|
||||||
|
"test": "vitest run",
|
||||||
|
"test:watch": "vitest",
|
||||||
|
"test:browser": "playwright test",
|
||||||
|
"manifest:generate": "node scripts/generate-toolbox-manifest.mjs",
|
||||||
|
"manifest:check": "node scripts/generate-toolbox-manifest.mjs --check",
|
||||||
|
"release:prepare": "node scripts/prepare-release-files.mjs",
|
||||||
|
"toolbox:check": "toolbox-check dist",
|
||||||
|
"package:release": "node scripts/package-release.mjs",
|
||||||
|
"check": "npm run manifest:check && npm run typecheck && npm run lint && npm run format:check && npm run test && npm run build && npm run toolbox:check",
|
||||||
|
"release:artifact": "npm run check && npm run test:browser && npm run package:release -- --force"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@add-ideas/toolbox-contract": "0.2.3",
|
||||||
|
"@add-ideas/toolbox-helpers": "0.1.0",
|
||||||
|
"@add-ideas/toolbox-shell-react": "0.2.3",
|
||||||
|
"@zip.js/zip.js": "2.9.0",
|
||||||
|
"dompurify": "3.4.14",
|
||||||
|
"react": "19.2.8",
|
||||||
|
"react-dom": "19.2.8"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@add-ideas/toolbox-testkit": "0.2.3",
|
||||||
|
"@eslint/js": "10.0.1",
|
||||||
|
"@playwright/test": "1.62.1",
|
||||||
|
"@testing-library/jest-dom": "6.9.1",
|
||||||
|
"@testing-library/react": "16.3.2",
|
||||||
|
"@testing-library/user-event": "14.6.1",
|
||||||
|
"@types/node": "25.9.5",
|
||||||
|
"@types/react": "19.2.17",
|
||||||
|
"@types/react-dom": "19.2.5",
|
||||||
|
"@vitejs/plugin-react": "6.0.3",
|
||||||
|
"eslint": "10.7.0",
|
||||||
|
"eslint-plugin-react-hooks": "7.1.1",
|
||||||
|
"eslint-plugin-react-refresh": "0.5.2",
|
||||||
|
"globals": "17.7.0",
|
||||||
|
"jsdom": "29.1.1",
|
||||||
|
"prettier": "3.9.5",
|
||||||
|
"typescript": "6.0.3",
|
||||||
|
"typescript-eslint": "8.64.0",
|
||||||
|
"vite": "8.2.2",
|
||||||
|
"vitest": "4.1.11"
|
||||||
|
},
|
||||||
|
"packageManager": "npm@11.17.0"
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
import { defineConfig, devices } from "@playwright/test";
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
testDir: "./tests/browser",
|
||||||
|
fullyParallel: false,
|
||||||
|
workers: 1,
|
||||||
|
timeout: 120_000,
|
||||||
|
expect: { timeout: 10_000 },
|
||||||
|
reporter: [["list"]],
|
||||||
|
use: { baseURL: "http://127.0.0.1:4173", trace: "retain-on-failure" },
|
||||||
|
webServer: {
|
||||||
|
command: "npm run build && node scripts/serve-test.mjs",
|
||||||
|
url: "http://127.0.0.1:4173",
|
||||||
|
reuseExistingServer: !process.env.CI,
|
||||||
|
timeout: 180_000,
|
||||||
|
},
|
||||||
|
projects: [
|
||||||
|
{ name: "chromium", use: { ...devices["Desktop Chrome"] } },
|
||||||
|
{ name: "firefox", use: { ...devices["Desktop Firefox"] } },
|
||||||
|
],
|
||||||
|
});
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 0.1.0 - 2026-09-01
|
||||||
|
|
||||||
|
- Added the initial local-first EPUB Tools workbench.
|
||||||
|
- Added EPUB 2/3 package, metadata, manifest, spine, navigation and NCX inspection.
|
||||||
|
- Added bounded link/structure validation and a sandboxed, sanitized, script-free reader with local images.
|
||||||
|
- Added metadata, package-tree, validation, cover, plain-text and sanitized-chapter exports.
|
||||||
|
- Added Dublin Core and declared-cover editing plus normalized EPUB rebuilding.
|
||||||
|
- Added strict path, size, entry-count, ratio, XML/entity, encryption and active-content policies.
|
||||||
|
- Added Toolbox integration, offline shell, deterministic release packaging, unit fixtures and real cross-browser EPUB workflow tests.
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
Run `npm ci`, `npm run check`, and `npm run test:browser` before proposing a change. Keep processing local, preserve explicit limits, and include fixtures for every parser boundary.
|
||||||
+674
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Licences
|
||||||
|
|
||||||
|
The application is GPL-3.0-or-later. Generated release artifacts include an exact runtime dependency licence inventory in `npm-runtime-licenses.txt`.
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,40 @@
|
|||||||
|
# EPUB Tools
|
||||||
|
|
||||||
|
EPUB Tools is a standalone, local-first EPUB 2/3 reader and publication workbench for the [add·ideas Toolbox](https://git.add-ideas.de/lotobo/toolbox-portal). Books are opened from a browser `File`; no upload, account, analytics, or server-side conversion is involved.
|
||||||
|
|
||||||
|
## Version 0.1.0
|
||||||
|
|
||||||
|
- Opens strict ZIP-based EPUB containers and parses `container.xml`, OPF metadata, manifest, spine, EPUB 3 navigation documents, and EPUB 2 NCX navigation.
|
||||||
|
- Shows a reading-order sidebar and renders XHTML/HTML/SVG content in a sandboxed, script-free iframe. Local images are resolved to temporary object URLs.
|
||||||
|
- Inventories the package and checks required metadata, mimetype ordering/compression, manifest/spine targets, navigation, active content, external resources, missing relative links, hidden entries, encryption metadata, and signatures.
|
||||||
|
- Edits common Dublin Core fields, replaces an existing declared JPEG/PNG/WebP/SVG cover, exports metadata/report/tree JSON, extracts the cover, exports reading-order text, and downloads sanitized chapters.
|
||||||
|
- Rebuilds a fresh EPUB with the uncompressed mimetype first, sorted paths, optional normalized timestamps, updated OPF metadata, and an optional replacement cover.
|
||||||
|
|
||||||
|
The validator is a focused preflight, not a browser port of EPUBCheck. Version 0.1 does not claim complete schema, CSS, accessibility, media-overlay, signature, DRM, or font-licence validation. DRM is detected and reported; it is never bypassed. Rebuilds are disabled when encryption metadata is present and invalidate existing signatures.
|
||||||
|
|
||||||
|
## Safety limits
|
||||||
|
|
||||||
|
- 512 MiB source file, 20,000 entries, 1 GiB declared expanded total
|
||||||
|
- 64 MiB per resource, 500:1 maximum declared expansion ratio
|
||||||
|
- 16 MiB package/chapter parse limit
|
||||||
|
- Link validation scans at most 500 content documents and 32 MiB total, with every skipped scope disclosed
|
||||||
|
- Reader image resolution is capped at 25 MiB per image; plain-text export at 32 MiB
|
||||||
|
- Absolute, backslash, drive-letter, NUL, and parent-traversal archive paths are rejected
|
||||||
|
|
||||||
|
DTD/entity declarations, ZIP encryption, scripts, forms, frames, objects, external reader resources, navigation, stylesheet links, CSS imports/URLs, and event handlers are blocked or removed from the reader surface. Rendering still depends on the current browser and installed fonts.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
Requires Node.js 22 and npm 11.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm ci
|
||||||
|
npm run check
|
||||||
|
npm run test:browser
|
||||||
|
```
|
||||||
|
|
||||||
|
`npm run release:artifact` creates `release/epub-tools-0.1.0.zip` and its SHA-256 sidecar.
|
||||||
|
|
||||||
|
## Licence
|
||||||
|
|
||||||
|
GPL-3.0-or-later. Runtime dependencies retain their own licences; see [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
Please report vulnerabilities privately to the repository owner. Do not attach sensitive source files to public issues. Imported inputs are untrusted; parsers must remain bounded and must not execute active content or fetch external resources.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Corresponding source
|
||||||
|
|
||||||
|
The corresponding source for EPUB Tools 0.1.0 is available at:
|
||||||
|
|
||||||
|
https://git.add-ideas.de/lotobo/epub-tools/src/tag/v0.1.0
|
||||||
|
|
||||||
|
Build with Node.js 22, npm 11, `npm ci`, and `npm run release:artifact`.
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# Third-party notices
|
||||||
|
|
||||||
|
Production release inventories reproduce exact dependency licence texts under `LICENSES/npm-runtime-licenses.txt`.
|
||||||
|
|
||||||
|
- `@zip.js/zip.js` 2.9.0 — BSD-3-Clause — bounded ZIP reading and EPUB rebuilding.
|
||||||
|
- `dompurify` 3.4.14 — MPL-2.0 OR Apache-2.0 — active-content sanitization before sandboxed rendering.
|
||||||
|
- Toolbox contract, shell, and test packages 0.2.3 — Apache-2.0.
|
||||||
|
- `@add-ideas/toolbox-helpers` 0.1.0 — GPL-3.0-or-later — bounded decoding, filenames, and browser downloads.
|
||||||
|
- React and React DOM 19.2.8 — MIT.
|
||||||
|
|
||||||
|
EPUB publications opened by a user are not bundled and retain their own copyright and licence terms.
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
# Accessibility
|
||||||
|
|
||||||
|
The application uses labelled file inputs, fields, tabs, status/error regions, keyboard-operable chapter and action buttons, visible focus indicators, responsive layouts, and scrollable tables/readers. The iframe has a chapter-specific accessible title.
|
||||||
|
|
||||||
|
Reader sanitization can remove scripted or form-based interactions by design. EPUB-internal navigation is disabled in v0.1; the Toolbox reading-order sidebar remains keyboard accessible. Publisher content can itself have poor semantics, contrast, directionality, alt text, or reading order. The safe reader does not certify EPUB accessibility and its fallback stylesheet may change publisher presentation.
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Architecture
|
||||||
|
|
||||||
|
The app is a relocatable static React application using the Toolbox shell and contract. EPUB work is divided into small TypeScript modules under `src/epub/`:
|
||||||
|
|
||||||
|
- `archive.ts` applies ZIP/path/entry/ratio limits and opens the container with zip.js.
|
||||||
|
- `xml.ts`, `package.ts`, and `paths.ts` decode bounded XML, reject DTD/entity input, parse OPF/navigation/NCX, and resolve package-relative references without traversal.
|
||||||
|
- `validation.ts` performs bounded package and cross-document diagnostics and reports skipped scope.
|
||||||
|
- `reader.ts` sanitizes content with DOMPurify, neutralizes navigation and CSS URLs, resolves bounded local images, injects a restrictive iframe CSP, and returns object URLs with an explicit revocation lifecycle.
|
||||||
|
- `export.ts` patches Dublin Core metadata and streams entries into a fresh normalized EPUB. It also produces JSON, cover, chapter, and reading-order text exports.
|
||||||
|
|
||||||
|
zip.js receives a lazy browser `BlobReader`, performs CRC checks when entry data is read, and can use web workers. React retains one open reader and closes the previous reader when a new book replaces it. The original File is immutable; all changes exist only in staged React state or a newly downloaded Blob.
|
||||||
|
|
||||||
|
The safe reader uses both sanitization and an iframe without sandbox permissions. Its `srcdoc` adds `default-src 'none'` and permits only inline styles plus local data/blob image/font/media URLs. Publisher stylesheet links are intentionally removed in v0.1.
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Privacy and security
|
||||||
|
|
||||||
|
All source and generated publication data remains in the browser. The app has no telemetry, account, analytics, remote font, CDN, or default network integration. The production CSP keeps `connect-src` and worker sources same-origin.
|
||||||
|
|
||||||
|
EPUB input is adversarial. Before extraction the app enforces file, entry, expanded-size, per-entry, expansion-ratio, duplicate-name, and path rules. Required XML is size-bounded, supports UTF-8/UTF-16, and rejects DTD/entity declarations. ZIP-encrypted entries cannot be read. `META-INF/encryption.xml` is reported because it can describe valid font obfuscation or DRM; the app does not distinguish every scheme and never attempts circumvention.
|
||||||
|
|
||||||
|
Content documents are never mounted into the application DOM. DOMPurify removes active elements and event handlers, navigation and resource references are neutralized or replaced with bounded local object URLs, and rendering happens inside a permissionless sandboxed iframe with its own restrictive CSP. Temporary object URLs are revoked when chapters change.
|
||||||
|
|
||||||
|
Validation is intentionally bounded and incomplete. It does not establish publication safety, conformance, accessibility, authenticity, ownership, or freedom from hidden data. Reports identify the checks performed and relevant unsupported areas. Rebuilding changes compressed bytes and invalidates signatures; it is disabled for encrypted publications.
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="EPUB Tools"><path fill="#5b4ec4" d="M11 4h30l12 12v44H11z"/><path fill="#fff" opacity=".28" d="M41 4v14h12"/><text x="32" y="43" fill="#fff" font-family="system-ui,sans-serif" font-size="18" font-weight="800" text-anchor="middle">EP</text></svg>
|
||||||
|
After Width: | Height: | Size: 329 B |
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"name": "EPUB Tools",
|
||||||
|
"short_name": "EPUB",
|
||||||
|
"description": "Read, inspect and repair EPUB publications locally in the browser.",
|
||||||
|
"start_url": "./",
|
||||||
|
"scope": "./",
|
||||||
|
"display": "standalone",
|
||||||
|
"background_color": "#f6f7fb",
|
||||||
|
"theme_color": "#29255f",
|
||||||
|
"icons": [
|
||||||
|
{
|
||||||
|
"src": "./favicon.svg",
|
||||||
|
"sizes": "any",
|
||||||
|
"type": "image/svg+xml",
|
||||||
|
"purpose": "any maskable"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
const CACHE_PREFIX = "epub-tools-shell-";
|
||||||
|
const CACHE_NAME = CACHE_PREFIX + "0.1.0";
|
||||||
|
const CORE = ["./", "./manifest.webmanifest", "./favicon.svg"];
|
||||||
|
self.addEventListener("install", (event) => {
|
||||||
|
event.waitUntil(
|
||||||
|
caches.open(CACHE_NAME).then(async (cache) => {
|
||||||
|
await cache.addAll(CORE);
|
||||||
|
const html = await (await fetch("./")).text();
|
||||||
|
const assets = [...html.matchAll(/(?:src|href)="(\.\/assets\/[^"]+)"/g)]
|
||||||
|
.map((match) => match[1])
|
||||||
|
.filter(Boolean);
|
||||||
|
await cache.addAll(assets);
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
self.skipWaiting();
|
||||||
|
});
|
||||||
|
self.addEventListener("activate", (event) => {
|
||||||
|
event.waitUntil(
|
||||||
|
caches
|
||||||
|
.keys()
|
||||||
|
.then((keys) =>
|
||||||
|
Promise.all(
|
||||||
|
keys
|
||||||
|
.filter((key) => key.startsWith(CACHE_PREFIX) && key !== CACHE_NAME)
|
||||||
|
.map((key) => caches.delete(key)),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.then(() => self.clients.claim()),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
self.addEventListener("fetch", (event) => {
|
||||||
|
if (event.request.method !== "GET") return;
|
||||||
|
const url = new URL(event.request.url);
|
||||||
|
if (
|
||||||
|
url.origin !== self.location.origin ||
|
||||||
|
!url.pathname.startsWith(new URL(self.registration.scope).pathname)
|
||||||
|
)
|
||||||
|
return;
|
||||||
|
event.respondWith(
|
||||||
|
caches.match(event.request).then(
|
||||||
|
(cached) =>
|
||||||
|
cached ??
|
||||||
|
fetch(event.request).then((response) => {
|
||||||
|
if (response.ok) {
|
||||||
|
const copy = response.clone();
|
||||||
|
void caches
|
||||||
|
.open(CACHE_NAME)
|
||||||
|
.then((cache) => cache.put(event.request, copy));
|
||||||
|
}
|
||||||
|
return response;
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
});
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://git.add-ideas.de/lotobo/toolbox-sdk/raw/branch/main/schemas/toolbox-app.v1.schema.json",
|
||||||
|
"schemaVersion": 1,
|
||||||
|
"id": "de.add-ideas.epub-tools",
|
||||||
|
"name": "EPUB Tools",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Read, inspect and repair EPUB publications locally in the browser.",
|
||||||
|
"entry": "./",
|
||||||
|
"icon": "./favicon.svg",
|
||||||
|
"categories": ["documents", "ebooks", "publishing"],
|
||||||
|
"tags": ["epub", "ebook", "metadata", "reader", "repair"],
|
||||||
|
"integration": {
|
||||||
|
"contextVersion": 1,
|
||||||
|
"launchModes": ["navigate", "new-tab"],
|
||||||
|
"embedding": "unsupported"
|
||||||
|
},
|
||||||
|
"requirements": {
|
||||||
|
"secureContext": false,
|
||||||
|
"workers": true,
|
||||||
|
"indexedDb": false,
|
||||||
|
"crossOriginIsolated": false,
|
||||||
|
"topLevelContext": false
|
||||||
|
},
|
||||||
|
"privacy": {
|
||||||
|
"processing": "local",
|
||||||
|
"fileUploads": true,
|
||||||
|
"telemetry": false,
|
||||||
|
"label": "Inputs stay in this browser; nothing is uploaded."
|
||||||
|
},
|
||||||
|
"source": {
|
||||||
|
"repository": "https://git.add-ideas.de/lotobo/epub-tools",
|
||||||
|
"license": "GPL-3.0-or-later"
|
||||||
|
},
|
||||||
|
"actions": [
|
||||||
|
{
|
||||||
|
"id": "source",
|
||||||
|
"label": "Source",
|
||||||
|
"url": "https://git.add-ideas.de/lotobo/epub-tools"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
import { readFile, writeFile } from "node:fs/promises";
|
||||||
|
import path from "node:path";
|
||||||
|
import { fileURLToPath } from "node:url";
|
||||||
|
import { format } from "prettier";
|
||||||
|
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
||||||
|
const sourcePath = path.join(root, "src/toolbox/manifest.source.json");
|
||||||
|
const outputPath = path.join(root, "public/toolbox-app.json");
|
||||||
|
const source = JSON.parse(await readFile(sourcePath, "utf8"));
|
||||||
|
const pkg = JSON.parse(await readFile(path.join(root, "package.json"), "utf8"));
|
||||||
|
const versionSource = await readFile(path.join(root, "src/version.ts"), "utf8");
|
||||||
|
const appVersion = /^export const APP_VERSION = "([^"]+)";$/mu.exec(
|
||||||
|
versionSource,
|
||||||
|
)?.[1];
|
||||||
|
const repository = "https://git.add-ideas.de/lotobo/" + pkg.name;
|
||||||
|
if (source.version !== pkg.version || appVersion !== pkg.version)
|
||||||
|
throw new Error("Version identity drift");
|
||||||
|
if (
|
||||||
|
source.id !== "de.add-ideas." + pkg.name ||
|
||||||
|
source.source?.repository !== repository ||
|
||||||
|
source.source?.license !== "GPL-3.0-or-later"
|
||||||
|
)
|
||||||
|
throw new Error("Manifest source identity is invalid");
|
||||||
|
const serialized = await format(JSON.stringify(source), {
|
||||||
|
filepath: outputPath,
|
||||||
|
});
|
||||||
|
if (process.argv.includes("--check")) {
|
||||||
|
if ((await readFile(outputPath, "utf8").catch(() => "")) !== serialized)
|
||||||
|
throw new Error("public/toolbox-app.json is stale");
|
||||||
|
console.log("Toolbox manifest is synchronized");
|
||||||
|
} else {
|
||||||
|
await writeFile(outputPath, serialized);
|
||||||
|
console.log("Generated public/toolbox-app.json");
|
||||||
|
}
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
import { createHash } from "node:crypto";
|
||||||
|
import { execFile } from "node:child_process";
|
||||||
|
import {
|
||||||
|
access,
|
||||||
|
chmod,
|
||||||
|
copyFile,
|
||||||
|
cp,
|
||||||
|
lstat,
|
||||||
|
mkdir,
|
||||||
|
mkdtemp,
|
||||||
|
readFile,
|
||||||
|
readdir,
|
||||||
|
rename,
|
||||||
|
rm,
|
||||||
|
utimes,
|
||||||
|
writeFile,
|
||||||
|
} from "node:fs/promises";
|
||||||
|
import os from "node:os";
|
||||||
|
import path from "node:path";
|
||||||
|
import { promisify } from "node:util";
|
||||||
|
import { fileURLToPath } from "node:url";
|
||||||
|
const execute = promisify(execFile);
|
||||||
|
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
||||||
|
const pkg = JSON.parse(await readFile(path.join(root, "package.json"), "utf8"));
|
||||||
|
const argument = (name, fallback) => {
|
||||||
|
const index = process.argv.indexOf(name);
|
||||||
|
return index >= 0 ? process.argv[index + 1] : fallback;
|
||||||
|
};
|
||||||
|
const output = path.resolve(
|
||||||
|
root,
|
||||||
|
argument("--output", "release/" + pkg.name + "-" + pkg.version + ".zip"),
|
||||||
|
);
|
||||||
|
const checksumOutput = output + ".sha256";
|
||||||
|
const force = process.argv.includes("--force");
|
||||||
|
if (
|
||||||
|
path.extname(output).toLowerCase() !== ".zip" ||
|
||||||
|
output === root ||
|
||||||
|
output === path.parse(output).root
|
||||||
|
)
|
||||||
|
throw new Error("Unsafe release target");
|
||||||
|
const exists = (file) =>
|
||||||
|
access(file).then(
|
||||||
|
() => true,
|
||||||
|
() => false,
|
||||||
|
);
|
||||||
|
if (!force && ((await exists(output)) || (await exists(checksumOutput))))
|
||||||
|
throw new Error("Release output exists");
|
||||||
|
const input = path.join(root, "dist");
|
||||||
|
for (const name of [
|
||||||
|
"index.html",
|
||||||
|
"manifest.webmanifest",
|
||||||
|
"sw.js",
|
||||||
|
"toolbox-app.json",
|
||||||
|
"favicon.svg",
|
||||||
|
"README.md",
|
||||||
|
"CHANGELOG.md",
|
||||||
|
"CONTRIBUTING.md",
|
||||||
|
"LICENSE",
|
||||||
|
"SECURITY.md",
|
||||||
|
"SOURCE.md",
|
||||||
|
"THIRD_PARTY_NOTICES.md",
|
||||||
|
"LICENSES/README.md",
|
||||||
|
"LICENSES/npm-runtime-licenses.txt",
|
||||||
|
"docs/ACCESSIBILITY.md",
|
||||||
|
"docs/ARCHITECTURE.md",
|
||||||
|
"docs/PRIVACY-SECURITY.md",
|
||||||
|
]) {
|
||||||
|
const details = await lstat(path.join(input, name)).catch(() => null);
|
||||||
|
if (!details?.isFile() || details.isSymbolicLink())
|
||||||
|
throw new Error("Missing release file: " + name);
|
||||||
|
}
|
||||||
|
const manifest = JSON.parse(
|
||||||
|
await readFile(path.join(input, "toolbox-app.json"), "utf8"),
|
||||||
|
);
|
||||||
|
const repository = "https://git.add-ideas.de/lotobo/" + pkg.name;
|
||||||
|
if (
|
||||||
|
manifest.id !== "de.add-ideas." + pkg.name ||
|
||||||
|
manifest.version !== pkg.version ||
|
||||||
|
manifest.entry !== "./" ||
|
||||||
|
manifest.icon !== "./favicon.svg" ||
|
||||||
|
manifest.source?.repository !== repository
|
||||||
|
)
|
||||||
|
throw new Error("Packaged manifest identity is invalid");
|
||||||
|
if (
|
||||||
|
/\b(?:src|href)=["']\//iu.test(
|
||||||
|
await readFile(path.join(input, "index.html"), "utf8"),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
throw new Error("Root-absolute asset reference");
|
||||||
|
async function collect(directory, prefix = "") {
|
||||||
|
const files = [];
|
||||||
|
for (const entry of (await readdir(directory, { withFileTypes: true })).sort(
|
||||||
|
(a, b) => a.name.localeCompare(b.name),
|
||||||
|
)) {
|
||||||
|
const absolute = path.join(directory, entry.name);
|
||||||
|
const relative = prefix ? prefix + "/" + entry.name : entry.name;
|
||||||
|
if (entry.isSymbolicLink())
|
||||||
|
throw new Error("Symlink in release: " + relative);
|
||||||
|
if (entry.isDirectory()) files.push(...(await collect(absolute, relative)));
|
||||||
|
else if (entry.isFile()) files.push({ absolute, relative });
|
||||||
|
else throw new Error("Unsupported release entry: " + relative);
|
||||||
|
}
|
||||||
|
return files;
|
||||||
|
}
|
||||||
|
const sourceFiles = await collect(input);
|
||||||
|
for (const file of sourceFiles)
|
||||||
|
if (
|
||||||
|
file.relative.endsWith(".map") ||
|
||||||
|
/(?:^|\/)(?:\.env(?:\.|$)|id_rsa|id_ed25519|.*\.pem$|.*\.key$)/iu.test(
|
||||||
|
file.relative,
|
||||||
|
) ||
|
||||||
|
file.relative.split("/").includes("..")
|
||||||
|
)
|
||||||
|
throw new Error("Forbidden release entry: " + file.relative);
|
||||||
|
await mkdir(path.dirname(output), { recursive: true });
|
||||||
|
const stagingRoot = await mkdtemp(
|
||||||
|
path.join(os.tmpdir(), pkg.name + "-release-"),
|
||||||
|
);
|
||||||
|
const publicationRoot = await mkdtemp(
|
||||||
|
path.join(path.dirname(output), "." + pkg.name + "-publish-"),
|
||||||
|
);
|
||||||
|
const stagedTree = path.join(stagingRoot, "tree");
|
||||||
|
const stagedArchive = path.join(stagingRoot, path.basename(output));
|
||||||
|
try {
|
||||||
|
await cp(input, stagedTree, { recursive: true });
|
||||||
|
const timestamp = new Date("1980-01-01T00:00:00.000Z");
|
||||||
|
for (const file of await collect(stagedTree)) {
|
||||||
|
await chmod(file.absolute, 0o644);
|
||||||
|
await utimes(file.absolute, timestamp, timestamp);
|
||||||
|
}
|
||||||
|
await execute(
|
||||||
|
"zip",
|
||||||
|
[
|
||||||
|
"-X",
|
||||||
|
"-q",
|
||||||
|
"-9",
|
||||||
|
stagedArchive,
|
||||||
|
...sourceFiles.map((file) => file.relative),
|
||||||
|
],
|
||||||
|
{
|
||||||
|
cwd: stagedTree,
|
||||||
|
env: { ...process.env, TZ: "UTC" },
|
||||||
|
maxBuffer: 1024 * 1024,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const archive = await readFile(stagedArchive);
|
||||||
|
const digest = createHash("sha256").update(archive).digest("hex");
|
||||||
|
const stagedChecksum = stagedArchive + ".sha256";
|
||||||
|
await writeFile(stagedChecksum, digest + " " + path.basename(output) + "\n");
|
||||||
|
const publicationArchive = path.join(publicationRoot, path.basename(output));
|
||||||
|
const publicationChecksum = publicationArchive + ".sha256";
|
||||||
|
await copyFile(stagedArchive, publicationArchive);
|
||||||
|
await copyFile(stagedChecksum, publicationChecksum);
|
||||||
|
if (force) {
|
||||||
|
await rm(output, { force: true });
|
||||||
|
await rm(checksumOutput, { force: true });
|
||||||
|
}
|
||||||
|
await rename(publicationArchive, output);
|
||||||
|
await rename(publicationChecksum, checksumOutput);
|
||||||
|
console.log("Created " + path.relative(root, output) + "\nSHA-256 " + digest);
|
||||||
|
} finally {
|
||||||
|
await rm(stagingRoot, { recursive: true, force: true });
|
||||||
|
await rm(publicationRoot, { recursive: true, force: true });
|
||||||
|
}
|
||||||
@@ -0,0 +1,70 @@
|
|||||||
|
import { cp, mkdir, readFile, readdir, rm, writeFile } from "node:fs/promises";
|
||||||
|
import path from "node:path";
|
||||||
|
import { fileURLToPath } from "node:url";
|
||||||
|
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
||||||
|
const destination = path.join(root, "public");
|
||||||
|
for (const name of [
|
||||||
|
"LICENSE",
|
||||||
|
"README.md",
|
||||||
|
"CHANGELOG.md",
|
||||||
|
"CONTRIBUTING.md",
|
||||||
|
"SECURITY.md",
|
||||||
|
"SOURCE.md",
|
||||||
|
"THIRD_PARTY_NOTICES.md",
|
||||||
|
]) {
|
||||||
|
await readFile(path.join(root, name));
|
||||||
|
await cp(path.join(root, name), path.join(destination, name));
|
||||||
|
}
|
||||||
|
for (const directory of ["LICENSES", "docs"]) {
|
||||||
|
const output = path.join(destination, directory);
|
||||||
|
await rm(output, { recursive: true, force: true });
|
||||||
|
await cp(path.join(root, directory), output, { recursive: true });
|
||||||
|
}
|
||||||
|
const lock = JSON.parse(
|
||||||
|
await readFile(path.join(root, "package-lock.json"), "utf8"),
|
||||||
|
);
|
||||||
|
const sections = [];
|
||||||
|
for (const [location, locked] of Object.entries(lock.packages ?? {}).sort(
|
||||||
|
([a], [b]) => a.localeCompare(b),
|
||||||
|
)) {
|
||||||
|
if (!location.includes("node_modules/") || locked.dev === true) continue;
|
||||||
|
const packageDirectory = path.join(root, location);
|
||||||
|
const details = JSON.parse(
|
||||||
|
await readFile(path.join(packageDirectory, "package.json"), "utf8"),
|
||||||
|
);
|
||||||
|
const candidates = (await readdir(packageDirectory))
|
||||||
|
.filter((name) => /^(?:licen[cs]e|copying|notice)(?:\.|$)/iu.test(name))
|
||||||
|
.sort();
|
||||||
|
const texts = [];
|
||||||
|
for (const candidate of candidates) {
|
||||||
|
try {
|
||||||
|
texts.push(
|
||||||
|
"--- " +
|
||||||
|
candidate +
|
||||||
|
" ---\n" +
|
||||||
|
(await readFile(path.join(packageDirectory, candidate), "utf8")),
|
||||||
|
);
|
||||||
|
} catch {
|
||||||
|
/* directory */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sections.push(
|
||||||
|
"=".repeat(78) +
|
||||||
|
"\n" +
|
||||||
|
details.name +
|
||||||
|
"@" +
|
||||||
|
details.version +
|
||||||
|
"\nDeclared licence: " +
|
||||||
|
(details.license ?? locked.license ?? "See upstream") +
|
||||||
|
"\n" +
|
||||||
|
"=".repeat(78) +
|
||||||
|
"\n" +
|
||||||
|
(texts.join("\n\n") || "See upstream package metadata."),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
await mkdir(path.join(destination, "LICENSES"), { recursive: true });
|
||||||
|
await writeFile(
|
||||||
|
path.join(destination, "LICENSES/npm-runtime-licenses.txt"),
|
||||||
|
sections.join("\n\n").trimEnd() + "\n",
|
||||||
|
);
|
||||||
|
console.log("Prepared release documentation");
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
import { createServer } from "node:http";
|
||||||
|
import { readFile, stat } from "node:fs/promises";
|
||||||
|
import path from "node:path";
|
||||||
|
import { fileURLToPath } from "node:url";
|
||||||
|
const root = path.resolve(
|
||||||
|
path.dirname(fileURLToPath(import.meta.url)),
|
||||||
|
"..",
|
||||||
|
"dist",
|
||||||
|
);
|
||||||
|
const prefix = "/deep/nested/epub/";
|
||||||
|
const types = new Map([
|
||||||
|
[".css", "text/css; charset=utf-8"],
|
||||||
|
[".html", "text/html; charset=utf-8"],
|
||||||
|
[".js", "text/javascript; charset=utf-8"],
|
||||||
|
[".json", "application/json; charset=utf-8"],
|
||||||
|
[".webmanifest", "application/manifest+json; charset=utf-8"],
|
||||||
|
[".svg", "image/svg+xml"],
|
||||||
|
[".md", "text/markdown; charset=utf-8"],
|
||||||
|
[".txt", "text/plain; charset=utf-8"],
|
||||||
|
[".wasm", "application/wasm"],
|
||||||
|
[".png", "image/png"],
|
||||||
|
[".jpg", "image/jpeg"],
|
||||||
|
[".webp", "image/webp"],
|
||||||
|
]);
|
||||||
|
const headers = {
|
||||||
|
"Content-Security-Policy":
|
||||||
|
"default-src 'self'; base-uri 'self'; object-src 'none'; frame-ancestors 'none'; form-action 'self'; script-src 'self' 'wasm-unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: blob:; media-src 'self' blob:; connect-src 'self'; worker-src 'self' blob:; manifest-src 'self'",
|
||||||
|
"Cross-Origin-Opener-Policy": "same-origin",
|
||||||
|
"Cross-Origin-Resource-Policy": "same-origin",
|
||||||
|
"Permissions-Policy":
|
||||||
|
"camera=(), microphone=(), geolocation=(), usb=(), payment=()",
|
||||||
|
"Referrer-Policy": "no-referrer",
|
||||||
|
"X-Content-Type-Options": "nosniff",
|
||||||
|
};
|
||||||
|
const server = createServer(async (request, response) => {
|
||||||
|
try {
|
||||||
|
const url = new URL(request.url ?? "/", "http://127.0.0.1");
|
||||||
|
const relative = decodeURIComponent(url.pathname).startsWith(prefix)
|
||||||
|
? decodeURIComponent(url.pathname).slice(prefix.length)
|
||||||
|
: decodeURIComponent(url.pathname).replace(/^\/+/, "");
|
||||||
|
const normalized = path.posix.normalize(relative || "index.html");
|
||||||
|
if (
|
||||||
|
normalized === ".." ||
|
||||||
|
normalized.startsWith("../") ||
|
||||||
|
path.isAbsolute(normalized)
|
||||||
|
) {
|
||||||
|
response.writeHead(400).end("Bad request");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
let file = path.join(root, normalized);
|
||||||
|
if ((await stat(file).catch(() => null))?.isDirectory())
|
||||||
|
file = path.join(file, "index.html");
|
||||||
|
const content = await readFile(file);
|
||||||
|
response.writeHead(200, {
|
||||||
|
"Content-Type":
|
||||||
|
types.get(path.extname(file)) ?? "application/octet-stream",
|
||||||
|
"Cache-Control": "no-cache",
|
||||||
|
...headers,
|
||||||
|
});
|
||||||
|
response.end(content);
|
||||||
|
} catch {
|
||||||
|
response.writeHead(404, { "Content-Type": "text/plain; charset=utf-8" });
|
||||||
|
response.end("Not found");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
server.listen(4173, "127.0.0.1", () => console.log("Test server ready"));
|
||||||
+35
@@ -0,0 +1,35 @@
|
|||||||
|
import { lazy, Suspense, useState } from "react";
|
||||||
|
import { AppShell } from "@add-ideas/toolbox-shell-react";
|
||||||
|
import "@add-ideas/toolbox-shell-react/styles.css";
|
||||||
|
import "./styles.css";
|
||||||
|
import { ErrorBoundary } from "./components/ErrorBoundary";
|
||||||
|
import { HelpDialog } from "./components/HelpDialog";
|
||||||
|
import { manifest } from "./toolbox/manifest";
|
||||||
|
|
||||||
|
const Workbench = lazy(async () => ({
|
||||||
|
default: (await import("./components/Workbench")).Workbench,
|
||||||
|
}));
|
||||||
|
|
||||||
|
export function App() {
|
||||||
|
const [helpOpen, setHelpOpen] = useState(false);
|
||||||
|
return (
|
||||||
|
<ErrorBoundary>
|
||||||
|
<AppShell
|
||||||
|
app={manifest}
|
||||||
|
manifestUrl="./toolbox-app.json"
|
||||||
|
helpAction={{ onClick: () => setHelpOpen(true) }}
|
||||||
|
>
|
||||||
|
<Suspense
|
||||||
|
fallback={
|
||||||
|
<p className="loading" role="status">
|
||||||
|
Preparing EPUB Tools…
|
||||||
|
</p>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
<Workbench />
|
||||||
|
</Suspense>
|
||||||
|
</AppShell>
|
||||||
|
<HelpDialog open={helpOpen} onClose={() => setHelpOpen(false)} />
|
||||||
|
</ErrorBoundary>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
import { Component, type ErrorInfo, type ReactNode } from "react";
|
||||||
|
|
||||||
|
export class ErrorBoundary extends Component<
|
||||||
|
{ children: ReactNode },
|
||||||
|
{ error?: Error }
|
||||||
|
> {
|
||||||
|
state: { error?: Error } = {};
|
||||||
|
static getDerivedStateFromError(error: Error) {
|
||||||
|
return { error };
|
||||||
|
}
|
||||||
|
componentDidCatch(error: Error, info: ErrorInfo) {
|
||||||
|
console.error("Application failure", error, info);
|
||||||
|
}
|
||||||
|
render() {
|
||||||
|
if (this.state.error)
|
||||||
|
return (
|
||||||
|
<main className="fatal">
|
||||||
|
<h1>EPUB Tools could not continue</h1>
|
||||||
|
<p>{this.state.error.message}</p>
|
||||||
|
<button type="button" onClick={() => location.reload()}>
|
||||||
|
Reload
|
||||||
|
</button>
|
||||||
|
</main>
|
||||||
|
);
|
||||||
|
return this.props.children;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import { useEffect, useRef } from "react";
|
||||||
|
|
||||||
|
export function HelpDialog({
|
||||||
|
open,
|
||||||
|
onClose,
|
||||||
|
}: {
|
||||||
|
open: boolean;
|
||||||
|
onClose: () => void;
|
||||||
|
}) {
|
||||||
|
const dialog = useRef<HTMLDialogElement>(null);
|
||||||
|
useEffect(() => {
|
||||||
|
const node = dialog.current;
|
||||||
|
if (!node) return;
|
||||||
|
if (open && !node.open) node.showModal();
|
||||||
|
if (!open && node.open) node.close();
|
||||||
|
}, [open]);
|
||||||
|
return (
|
||||||
|
<dialog
|
||||||
|
ref={dialog}
|
||||||
|
className="help-dialog"
|
||||||
|
onClose={onClose}
|
||||||
|
onCancel={onClose}
|
||||||
|
aria-labelledby="help-title"
|
||||||
|
>
|
||||||
|
<div className="dialog-heading">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">Local-first help</p>
|
||||||
|
<h2 id="help-title">About EPUB Tools</h2>
|
||||||
|
</div>
|
||||||
|
<button type="button" onClick={onClose} aria-label="Close help">
|
||||||
|
×
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<p>Read, inspect and repair EPUB publications locally in the browser.</p>
|
||||||
|
<p>
|
||||||
|
All processing is performed in this browser. Imported data is treated as
|
||||||
|
untrusted and bounded before parsing.
|
||||||
|
</p>
|
||||||
|
</dialog>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,732 @@
|
|||||||
|
import { useEffect, useMemo, useState } from "react";
|
||||||
|
import {
|
||||||
|
sanitizeDownloadFilename,
|
||||||
|
triggerBlobDownload,
|
||||||
|
} from "@add-ideas/toolbox-helpers";
|
||||||
|
import { closeBook, openEpub, readEntryBytes } from "../epub/archive";
|
||||||
|
import {
|
||||||
|
downloadJson,
|
||||||
|
exportPlainText,
|
||||||
|
rebuildEpub,
|
||||||
|
type MetadataPatch,
|
||||||
|
} from "../epub/export";
|
||||||
|
import { renderChapter, revokeRenderedChapter } from "../epub/reader";
|
||||||
|
import type {
|
||||||
|
EpubBook,
|
||||||
|
ManifestItem,
|
||||||
|
NavigationItem,
|
||||||
|
RenderedChapter,
|
||||||
|
} from "../epub/types";
|
||||||
|
|
||||||
|
type View = "reader" | "metadata" | "validation" | "package" | "export";
|
||||||
|
const views: ReadonlyArray<readonly [View, string]> = [
|
||||||
|
["reader", "Reader"],
|
||||||
|
["metadata", "Metadata"],
|
||||||
|
["validation", "Validation"],
|
||||||
|
["package", "Package tree"],
|
||||||
|
["export", "Export & rebuild"],
|
||||||
|
];
|
||||||
|
|
||||||
|
function initialMetadata(book: EpubBook): MetadataPatch {
|
||||||
|
return {
|
||||||
|
...book.package.metadata,
|
||||||
|
creators: [...book.package.metadata.creators],
|
||||||
|
subjects: [...book.package.metadata.subjects],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
function formatBytes(value: number): string {
|
||||||
|
if (value < 1024) return `${value} B`;
|
||||||
|
const units = ["KiB", "MiB", "GiB"];
|
||||||
|
let scaled = value / 1024;
|
||||||
|
let unit = 0;
|
||||||
|
while (scaled >= 1024 && unit < units.length - 1) {
|
||||||
|
scaled /= 1024;
|
||||||
|
unit += 1;
|
||||||
|
}
|
||||||
|
return `${scaled.toFixed(scaled < 10 ? 1 : 0)} ${units[unit]}`;
|
||||||
|
}
|
||||||
|
function flatten(items: NavigationItem[]): NavigationItem[] {
|
||||||
|
return items.flatMap((item) => [item, ...flatten(item.children)]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function EmptyState({ onFile }: { onFile: (file: File) => void }) {
|
||||||
|
return (
|
||||||
|
<section className="drop panel">
|
||||||
|
<div className="book-mark" aria-hidden="true">
|
||||||
|
EPUB
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">Open a local publication</p>
|
||||||
|
<h2>Inspect and read without uploading</h2>
|
||||||
|
<p>
|
||||||
|
Select an EPUB 2 or EPUB 3 file. Package parsing, validation, chapter
|
||||||
|
rendering, metadata editing, and rebuilding stay in this browser.
|
||||||
|
</p>
|
||||||
|
<label className="button primary">
|
||||||
|
Choose EPUB
|
||||||
|
<input
|
||||||
|
type="file"
|
||||||
|
accept=".epub,application/epub+zip"
|
||||||
|
onChange={(event) => {
|
||||||
|
const file = event.target.files?.[0];
|
||||||
|
if (file) onFile(file);
|
||||||
|
event.currentTarget.value = "";
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function Summary({ book }: { book: EpubBook }) {
|
||||||
|
const errors = book.issues.filter((item) => item.severity === "error").length;
|
||||||
|
const warnings = book.issues.filter(
|
||||||
|
(item) => item.severity === "warning",
|
||||||
|
).length;
|
||||||
|
return (
|
||||||
|
<section className="summary-grid">
|
||||||
|
<article>
|
||||||
|
<span>Title</span>
|
||||||
|
<strong>{book.package.metadata.title || "Untitled"}</strong>
|
||||||
|
<small>
|
||||||
|
{book.package.metadata.creators.join(", ") || "Unknown creator"}
|
||||||
|
</small>
|
||||||
|
</article>
|
||||||
|
<article>
|
||||||
|
<span>Format</span>
|
||||||
|
<strong>EPUB {book.package.version || "unknown"}</strong>
|
||||||
|
<small>
|
||||||
|
{book.package.spine.length} spine items ·{" "}
|
||||||
|
{book.package.manifest.length} manifest items
|
||||||
|
</small>
|
||||||
|
</article>
|
||||||
|
<article>
|
||||||
|
<span>Container</span>
|
||||||
|
<strong>{formatBytes(book.summary.fileSize)}</strong>
|
||||||
|
<small>
|
||||||
|
{book.summary.entryCount} entries ·{" "}
|
||||||
|
{formatBytes(book.summary.uncompressedBytes)} expanded
|
||||||
|
</small>
|
||||||
|
</article>
|
||||||
|
<article className={errors ? "bad" : warnings ? "warn" : "good"}>
|
||||||
|
<span>Validation</span>
|
||||||
|
<strong>
|
||||||
|
{errors} errors · {warnings} warnings
|
||||||
|
</strong>
|
||||||
|
<small>
|
||||||
|
{book.summary.encryptedResources
|
||||||
|
? "Encryption metadata detected"
|
||||||
|
: "No encryption metadata detected"}
|
||||||
|
</small>
|
||||||
|
</article>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ReaderView({
|
||||||
|
book,
|
||||||
|
chapter,
|
||||||
|
busy,
|
||||||
|
error,
|
||||||
|
onOpen,
|
||||||
|
}: {
|
||||||
|
book: EpubBook;
|
||||||
|
chapter?: RenderedChapter;
|
||||||
|
busy: boolean;
|
||||||
|
error: string;
|
||||||
|
onOpen: (item: ManifestItem) => void;
|
||||||
|
}) {
|
||||||
|
const navigation = useMemo(() => flatten(book.package.navigation), [book]);
|
||||||
|
const spine = book.package.spine.filter((item) => item.item && item.linear);
|
||||||
|
return (
|
||||||
|
<section className="reader-layout">
|
||||||
|
<aside className="panel chapter-list">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">Reading order</p>
|
||||||
|
<h2>Contents</h2>
|
||||||
|
</div>
|
||||||
|
{spine.map((spineItem, index) => {
|
||||||
|
const item = spineItem.item!;
|
||||||
|
const label =
|
||||||
|
navigation.find((entry) => entry.path === item.path)?.label ||
|
||||||
|
item.id ||
|
||||||
|
`Chapter ${index + 1}`;
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={chapter?.path === item.path ? "active" : ""}
|
||||||
|
key={`${item.id}-${index}`}
|
||||||
|
onClick={() => onOpen(item)}
|
||||||
|
>
|
||||||
|
<span>{index + 1}</span>
|
||||||
|
{label}
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</aside>
|
||||||
|
<section className="panel page-reader">
|
||||||
|
<div className="panel-heading">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">Sandboxed, script-free preview</p>
|
||||||
|
<h2>
|
||||||
|
{chapter?.title ??
|
||||||
|
(busy ? "Preparing chapter…" : "Choose a chapter")}
|
||||||
|
</h2>
|
||||||
|
</div>
|
||||||
|
{chapter && (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() =>
|
||||||
|
triggerBlobDownload(
|
||||||
|
new Blob([chapter.html], { type: "application/xhtml+xml" }),
|
||||||
|
sanitizeDownloadFilename(
|
||||||
|
`${chapter.title}.xhtml`,
|
||||||
|
"chapter.xhtml",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Export sanitized chapter
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
{error && (
|
||||||
|
<p className="error" role="alert">
|
||||||
|
{error}
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
{chapter ? (
|
||||||
|
<iframe
|
||||||
|
sandbox=""
|
||||||
|
title={`Safe EPUB preview: ${chapter.title}`}
|
||||||
|
srcDoc={chapter.html}
|
||||||
|
/>
|
||||||
|
) : (
|
||||||
|
<p className="empty">
|
||||||
|
{busy
|
||||||
|
? "Sanitizing the chapter and resolving local images…"
|
||||||
|
: "Choose an item from the reading order."}
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
<p className="notice">
|
||||||
|
Scripts, forms, frames, embedded objects, external resources,
|
||||||
|
navigation, stylesheet links, and CSS URLs are blocked or removed.
|
||||||
|
Inline publisher styling may remain after URL stripping; the reader
|
||||||
|
adds a responsive fallback stylesheet.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function MetadataView({
|
||||||
|
draft,
|
||||||
|
setDraft,
|
||||||
|
}: {
|
||||||
|
draft: MetadataPatch;
|
||||||
|
setDraft: (value: MetadataPatch) => void;
|
||||||
|
}) {
|
||||||
|
const field = (
|
||||||
|
key: keyof Omit<MetadataPatch, "creators" | "subjects">,
|
||||||
|
label: string,
|
||||||
|
multiline = false,
|
||||||
|
) => (
|
||||||
|
<label className="field">
|
||||||
|
<span>{label}</span>
|
||||||
|
{multiline ? (
|
||||||
|
<textarea
|
||||||
|
value={String(draft[key])}
|
||||||
|
onChange={(event) =>
|
||||||
|
setDraft({ ...draft, [key]: event.target.value })
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
) : (
|
||||||
|
<input
|
||||||
|
value={String(draft[key])}
|
||||||
|
onChange={(event) =>
|
||||||
|
setDraft({ ...draft, [key]: event.target.value })
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</label>
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<section className="panel workspace">
|
||||||
|
<p className="eyebrow">Editable Dublin Core fields</p>
|
||||||
|
<h2>Publication metadata</h2>
|
||||||
|
<div className="form-grid">
|
||||||
|
{field("title", "Title")}
|
||||||
|
{field("language", "Language")}
|
||||||
|
{field("identifier", "Identifier")}
|
||||||
|
{field("publisher", "Publisher")}
|
||||||
|
{field("date", "Date")}
|
||||||
|
{field("rights", "Rights")}
|
||||||
|
</div>
|
||||||
|
<label className="field">
|
||||||
|
<span>Creators (one per line)</span>
|
||||||
|
<textarea
|
||||||
|
value={draft.creators.join("\n")}
|
||||||
|
onChange={(event) =>
|
||||||
|
setDraft({ ...draft, creators: event.target.value.split(/\r?\n/u) })
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
<label className="field">
|
||||||
|
<span>Subjects (one per line)</span>
|
||||||
|
<textarea
|
||||||
|
value={draft.subjects.join("\n")}
|
||||||
|
onChange={(event) =>
|
||||||
|
setDraft({ ...draft, subjects: event.target.value.split(/\r?\n/u) })
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
{field("description", "Description", true)}
|
||||||
|
<p className="notice">
|
||||||
|
Edits remain staged until you create a rebuilt EPUB. The original File
|
||||||
|
object is never modified.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ValidationView({ book }: { book: EpubBook }) {
|
||||||
|
const grouped = (["error", "warning", "info"] as const).map(
|
||||||
|
(severity) =>
|
||||||
|
[
|
||||||
|
severity,
|
||||||
|
book.issues.filter((item) => item.severity === severity),
|
||||||
|
] as const,
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<section className="panel workspace">
|
||||||
|
<div className="panel-heading">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">Bounded structural and link checks</p>
|
||||||
|
<h2>Validation report</h2>
|
||||||
|
</div>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() =>
|
||||||
|
downloadJson(
|
||||||
|
{
|
||||||
|
schemaVersion: 1,
|
||||||
|
generatedBy: "add-ideas EPUB Tools 0.1.0",
|
||||||
|
file: book.summary,
|
||||||
|
package: book.package,
|
||||||
|
issues: book.issues,
|
||||||
|
},
|
||||||
|
"epub-validation-report.json",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Download JSON report
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
{grouped.map(([severity, issues]) => (
|
||||||
|
<section key={severity} className="issue-group">
|
||||||
|
<h3>
|
||||||
|
{severity} ({issues.length})
|
||||||
|
</h3>
|
||||||
|
{issues.length ? (
|
||||||
|
issues.map((item, index) => (
|
||||||
|
<article
|
||||||
|
className={`issue ${severity}`}
|
||||||
|
key={`${item.code}-${index}`}
|
||||||
|
>
|
||||||
|
<strong>{item.code}</strong>
|
||||||
|
<span>{item.message}</span>
|
||||||
|
{item.path && <code>{item.path}</code>}
|
||||||
|
</article>
|
||||||
|
))
|
||||||
|
) : (
|
||||||
|
<p className="muted">None.</p>
|
||||||
|
)}
|
||||||
|
</section>
|
||||||
|
))}
|
||||||
|
<p className="notice">
|
||||||
|
This is a focused in-browser preflight, not a claim of complete
|
||||||
|
EPUBCheck conformance. It does not validate CSS grammar, media overlays,
|
||||||
|
accessibility semantics, signatures, font licences, or every schema
|
||||||
|
constraint.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function PackageView({ book }: { book: EpubBook }) {
|
||||||
|
const mediaByPath = new Map(
|
||||||
|
book.package.manifest.map((item) => [item.path, item.mediaType]),
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<section className="panel workspace">
|
||||||
|
<div className="panel-heading">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">ZIP package inventory</p>
|
||||||
|
<h2>{book.summary.entryCount} entries</h2>
|
||||||
|
</div>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() =>
|
||||||
|
downloadJson(
|
||||||
|
{
|
||||||
|
file: book.summary.filename,
|
||||||
|
packagePath: book.package.packagePath,
|
||||||
|
entries: book.entries.map((entry) => ({
|
||||||
|
path: entry.filename,
|
||||||
|
directory: entry.directory,
|
||||||
|
compressedSize: entry.compressedSize,
|
||||||
|
uncompressedSize: entry.uncompressedSize,
|
||||||
|
encrypted: entry.encrypted,
|
||||||
|
mediaType: mediaByPath.get(entry.filename),
|
||||||
|
})),
|
||||||
|
},
|
||||||
|
"epub-package-tree.json",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Export inventory
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<div className="table-scroll">
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Path</th>
|
||||||
|
<th>Type</th>
|
||||||
|
<th>Compressed</th>
|
||||||
|
<th>Expanded</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
{book.entries.map((entry) => (
|
||||||
|
<tr key={`${entry.filename}-${entry.offset}`}>
|
||||||
|
<td>
|
||||||
|
<code>{entry.filename}</code>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
{entry.directory
|
||||||
|
? "directory"
|
||||||
|
: (mediaByPath.get(entry.filename) ?? "unmanifested")}
|
||||||
|
</td>
|
||||||
|
<td>{formatBytes(entry.compressedSize)}</td>
|
||||||
|
<td>{formatBytes(entry.uncompressedSize)}</td>
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ExportView({ book, draft }: { book: EpubBook; draft: MetadataPatch }) {
|
||||||
|
const [cover, setCover] = useState<File>();
|
||||||
|
const [normalize, setNormalize] = useState(true);
|
||||||
|
const [busy, setBusy] = useState(false);
|
||||||
|
const [status, setStatus] = useState("");
|
||||||
|
const [error, setError] = useState("");
|
||||||
|
const rebuild = async () => {
|
||||||
|
setBusy(true);
|
||||||
|
setError("");
|
||||||
|
try {
|
||||||
|
const result = await rebuildEpub(
|
||||||
|
book,
|
||||||
|
{ metadata: draft, cover, normalizeTimestamps: normalize },
|
||||||
|
setStatus,
|
||||||
|
);
|
||||||
|
triggerBlobDownload(
|
||||||
|
result.blob,
|
||||||
|
sanitizeDownloadFilename(
|
||||||
|
book.file.name.replace(/\.epub$/iu, "-updated.epub"),
|
||||||
|
"updated.epub",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
setStatus(`Ready: ${result.changes.join("; ")}`);
|
||||||
|
} catch (reason) {
|
||||||
|
setError(reason instanceof Error ? reason.message : "Rebuild failed.");
|
||||||
|
} finally {
|
||||||
|
setBusy(false);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const exportCover = async () => {
|
||||||
|
if (!book.package.cover) return;
|
||||||
|
try {
|
||||||
|
const bytes = await readEntryBytes(
|
||||||
|
book,
|
||||||
|
book.package.cover.path,
|
||||||
|
25 * 1024 * 1024,
|
||||||
|
);
|
||||||
|
triggerBlobDownload(
|
||||||
|
new Blob([bytes as BlobPart], { type: book.package.cover.mediaType }),
|
||||||
|
sanitizeDownloadFilename(book.package.cover.href, "cover"),
|
||||||
|
);
|
||||||
|
} catch (reason) {
|
||||||
|
setError(
|
||||||
|
reason instanceof Error ? reason.message : "Cover export failed.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const plainText = async () => {
|
||||||
|
setBusy(true);
|
||||||
|
try {
|
||||||
|
triggerBlobDownload(
|
||||||
|
await exportPlainText(book),
|
||||||
|
sanitizeDownloadFilename(
|
||||||
|
`${draft.title || "publication"}.txt`,
|
||||||
|
"publication.txt",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
} catch (reason) {
|
||||||
|
setError(
|
||||||
|
reason instanceof Error ? reason.message : "Text export failed.",
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
setBusy(false);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
return (
|
||||||
|
<section className="panel workspace">
|
||||||
|
<p className="eyebrow">Fresh deterministic container</p>
|
||||||
|
<h2>Export and rebuild</h2>
|
||||||
|
<div className="export-grid">
|
||||||
|
<article>
|
||||||
|
<h3>Portable reports</h3>
|
||||||
|
<p>
|
||||||
|
Export parsed metadata, structure, and validation without changing
|
||||||
|
the book.
|
||||||
|
</p>
|
||||||
|
<div className="actions">
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() =>
|
||||||
|
downloadJson(
|
||||||
|
{
|
||||||
|
schemaVersion: 1,
|
||||||
|
metadata: draft,
|
||||||
|
packageVersion: book.package.version,
|
||||||
|
packagePath: book.package.packagePath,
|
||||||
|
},
|
||||||
|
"epub-metadata.json",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Metadata JSON
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
disabled={busy}
|
||||||
|
onClick={() => void plainText()}
|
||||||
|
>
|
||||||
|
Reading-order text
|
||||||
|
</button>
|
||||||
|
{book.package.cover && (
|
||||||
|
<button type="button" onClick={() => void exportCover()}>
|
||||||
|
Original cover
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</article>
|
||||||
|
<article>
|
||||||
|
<h3>Updated EPUB</h3>
|
||||||
|
<p>
|
||||||
|
Write edited metadata, optionally replace the declared cover,
|
||||||
|
normalize timestamps, and repair mimetype ordering/compression.
|
||||||
|
</p>
|
||||||
|
<label className="field">
|
||||||
|
<span>
|
||||||
|
Replacement cover{" "}
|
||||||
|
{book.package.cover
|
||||||
|
? `(declared at ${book.package.cover.path})`
|
||||||
|
: "(no cover item declared)"}
|
||||||
|
</span>
|
||||||
|
<input
|
||||||
|
type="file"
|
||||||
|
disabled={!book.package.cover}
|
||||||
|
accept="image/jpeg,image/png,image/webp,image/svg+xml"
|
||||||
|
onChange={(event) => setCover(event.target.files?.[0])}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
<label className="check">
|
||||||
|
<input
|
||||||
|
type="checkbox"
|
||||||
|
checked={normalize}
|
||||||
|
onChange={(event) => setNormalize(event.target.checked)}
|
||||||
|
/>{" "}
|
||||||
|
Normalize entry timestamps to 1980-01-01 and sort paths
|
||||||
|
</label>
|
||||||
|
<button
|
||||||
|
className="primary"
|
||||||
|
type="button"
|
||||||
|
disabled={busy || book.summary.encryptedResources}
|
||||||
|
onClick={() => void rebuild()}
|
||||||
|
>
|
||||||
|
{busy ? "Rebuilding…" : "Create updated EPUB"}
|
||||||
|
</button>
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
{status && (
|
||||||
|
<p className="success" role="status">
|
||||||
|
{status}
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
{error && (
|
||||||
|
<p className="error" role="alert">
|
||||||
|
{error}
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
<p className="warning">
|
||||||
|
A rebuild re-compresses entries and invalidates existing package
|
||||||
|
signatures. It is disabled when encryption metadata exists. Replacement
|
||||||
|
cover MIME metadata is updated, but the existing internal filename is
|
||||||
|
retained and its extension can therefore differ.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function Workbench() {
|
||||||
|
const [book, setBook] = useState<EpubBook>();
|
||||||
|
const [view, setView] = useState<View>("reader");
|
||||||
|
const [draft, setDraft] = useState<MetadataPatch>();
|
||||||
|
const [chapter, setChapter] = useState<RenderedChapter>();
|
||||||
|
const [busy, setBusy] = useState(false);
|
||||||
|
const [chapterBusy, setChapterBusy] = useState(false);
|
||||||
|
const [error, setError] = useState("");
|
||||||
|
const [chapterError, setChapterError] = useState("");
|
||||||
|
useEffect(
|
||||||
|
() => () => {
|
||||||
|
void closeBook(book);
|
||||||
|
},
|
||||||
|
[book],
|
||||||
|
);
|
||||||
|
useEffect(() => () => revokeRenderedChapter(chapter), [chapter]);
|
||||||
|
const openChapter = async (item: ManifestItem, currentBook = book) => {
|
||||||
|
if (!currentBook) return;
|
||||||
|
setChapterBusy(true);
|
||||||
|
setChapterError("");
|
||||||
|
try {
|
||||||
|
setChapter(await renderChapter(currentBook, item.path));
|
||||||
|
} catch (reason) {
|
||||||
|
setChapterError(
|
||||||
|
reason instanceof Error ? reason.message : "Chapter rendering failed.",
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
setChapterBusy(false);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const openFile = async (file: File) => {
|
||||||
|
setBusy(true);
|
||||||
|
setError("");
|
||||||
|
setChapter(undefined);
|
||||||
|
try {
|
||||||
|
const opened = await openEpub(file);
|
||||||
|
setBook(opened);
|
||||||
|
setDraft(initialMetadata(opened));
|
||||||
|
setView("reader");
|
||||||
|
const first = opened.package.spine.find(
|
||||||
|
(item) => item.linear && item.item,
|
||||||
|
)?.item;
|
||||||
|
if (first) await openChapter(first, opened);
|
||||||
|
} catch (reason) {
|
||||||
|
setError(
|
||||||
|
reason instanceof Error ? reason.message : "Unable to open EPUB.",
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
setBusy(false);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const content =
|
||||||
|
book && draft ? (
|
||||||
|
view === "reader" ? (
|
||||||
|
<ReaderView
|
||||||
|
book={book}
|
||||||
|
chapter={chapter}
|
||||||
|
busy={chapterBusy}
|
||||||
|
error={chapterError}
|
||||||
|
onOpen={(item) => void openChapter(item)}
|
||||||
|
/>
|
||||||
|
) : view === "metadata" ? (
|
||||||
|
<MetadataView draft={draft} setDraft={setDraft} />
|
||||||
|
) : view === "validation" ? (
|
||||||
|
<ValidationView book={book} />
|
||||||
|
) : view === "package" ? (
|
||||||
|
<PackageView book={book} />
|
||||||
|
) : (
|
||||||
|
<ExportView book={book} draft={draft} />
|
||||||
|
)
|
||||||
|
) : null;
|
||||||
|
return (
|
||||||
|
<main className="workbench">
|
||||||
|
<header className="hero">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">Local publication workbench</p>
|
||||||
|
<h1>EPUB Tools</h1>
|
||||||
|
<p>
|
||||||
|
Read safely, inspect the package, validate links and structure, edit
|
||||||
|
metadata and covers, and create a normalized EPUB without uploading
|
||||||
|
the book.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<span className="privacy-pill">Sandboxed reader · local files</span>
|
||||||
|
</header>
|
||||||
|
{error && (
|
||||||
|
<p className="error" role="alert">
|
||||||
|
{error}
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
{busy && (
|
||||||
|
<p className="panel loading" role="status">
|
||||||
|
Opening and validating the bounded publication…
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
{!book && !busy ? (
|
||||||
|
<EmptyState onFile={(file) => void openFile(file)} />
|
||||||
|
) : (
|
||||||
|
book && (
|
||||||
|
<>
|
||||||
|
<div className="file-bar panel">
|
||||||
|
<div>
|
||||||
|
<strong>{book.file.name}</strong>
|
||||||
|
<span>
|
||||||
|
{book.package.metadata.title || "Untitled publication"}
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<label className="button">
|
||||||
|
Open another
|
||||||
|
<input
|
||||||
|
type="file"
|
||||||
|
accept=".epub,application/epub+zip"
|
||||||
|
onChange={(event) => {
|
||||||
|
const file = event.target.files?.[0];
|
||||||
|
if (file) void openFile(file);
|
||||||
|
event.currentTarget.value = "";
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<Summary book={book} />
|
||||||
|
<nav
|
||||||
|
className="panel workspace-tabs"
|
||||||
|
role="tablist"
|
||||||
|
aria-label="EPUB workspaces"
|
||||||
|
>
|
||||||
|
{views.map(([value, label]) => (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
role="tab"
|
||||||
|
aria-selected={view === value}
|
||||||
|
key={value}
|
||||||
|
onClick={() => setView(value)}
|
||||||
|
>
|
||||||
|
{label}
|
||||||
|
</button>
|
||||||
|
))}
|
||||||
|
</nav>
|
||||||
|
{content}
|
||||||
|
</>
|
||||||
|
)
|
||||||
|
)}
|
||||||
|
</main>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,172 @@
|
|||||||
|
import {
|
||||||
|
BlobReader,
|
||||||
|
Uint8ArrayWriter,
|
||||||
|
ZipReader,
|
||||||
|
type Entry,
|
||||||
|
} from "@zip.js/zip.js";
|
||||||
|
import { EPUB_LIMITS, readEntryText } from "./entries";
|
||||||
|
import {
|
||||||
|
parseNavigationDocument,
|
||||||
|
parseNcxDocument,
|
||||||
|
parsePackageDocument,
|
||||||
|
} from "./package";
|
||||||
|
import { validateEntryPath } from "./paths";
|
||||||
|
import type { EpubBook, EpubIssue } from "./types";
|
||||||
|
import { elementsByLocalName, parseXml } from "./xml";
|
||||||
|
import { validatePublication } from "./validation";
|
||||||
|
|
||||||
|
export { EPUB_LIMITS, readEntryBytes, readEntryText } from "./entries";
|
||||||
|
|
||||||
|
export async function closeBook(book: EpubBook | undefined): Promise<void> {
|
||||||
|
if (book) await book.reader.close();
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function openEpub(file: File): Promise<EpubBook> {
|
||||||
|
if (file.size === 0 || file.size > EPUB_LIMITS.fileBytes)
|
||||||
|
throw new RangeError("EPUB must be between 1 byte and 512 MiB.");
|
||||||
|
const reader = new ZipReader(new BlobReader(file), {
|
||||||
|
useWebWorkers: true,
|
||||||
|
strictness: "strict",
|
||||||
|
});
|
||||||
|
try {
|
||||||
|
const entries = await reader.getEntries();
|
||||||
|
if (!entries.length || entries.length > EPUB_LIMITS.entries)
|
||||||
|
throw new RangeError(
|
||||||
|
`EPUB entry count must be between 1 and ${EPUB_LIMITS.entries.toLocaleString()}.`,
|
||||||
|
);
|
||||||
|
let totalUncompressed = 0;
|
||||||
|
let compressedBytes = 0;
|
||||||
|
const entryByPath = new Map<string, Entry>();
|
||||||
|
for (const entry of entries) {
|
||||||
|
validateEntryPath(entry.filename.replace(/\/$/u, "") || entry.filename);
|
||||||
|
if (entryByPath.has(entry.filename))
|
||||||
|
throw new Error(`Duplicate archive path: ${entry.filename}`);
|
||||||
|
entryByPath.set(entry.filename, entry);
|
||||||
|
if (!entry.directory) {
|
||||||
|
totalUncompressed += entry.uncompressedSize;
|
||||||
|
compressedBytes += entry.compressedSize;
|
||||||
|
if (entry.uncompressedSize > EPUB_LIMITS.resourceBytes)
|
||||||
|
throw new RangeError(
|
||||||
|
`${entry.filename} exceeds the 64 MiB per-resource limit.`,
|
||||||
|
);
|
||||||
|
if (
|
||||||
|
entry.compressedSize === 0
|
||||||
|
? entry.uncompressedSize > 0
|
||||||
|
: entry.uncompressedSize / entry.compressedSize >
|
||||||
|
EPUB_LIMITS.expansionRatio
|
||||||
|
)
|
||||||
|
throw new RangeError(
|
||||||
|
`${entry.filename} exceeds the ${EPUB_LIMITS.expansionRatio}:1 expansion-ratio limit.`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (totalUncompressed > EPUB_LIMITS.totalUncompressedBytes)
|
||||||
|
throw new RangeError("EPUB exceeds the 1 GiB total uncompressed limit.");
|
||||||
|
const mimetypeEntry = entryByPath.get("mimetype");
|
||||||
|
if (!mimetypeEntry || mimetypeEntry.directory)
|
||||||
|
throw new Error("The EPUB has no root mimetype file.");
|
||||||
|
const mimetype = new TextDecoder("utf-8", { fatal: true }).decode(
|
||||||
|
await mimetypeEntry.getData(new Uint8ArrayWriter(), {
|
||||||
|
checkSignature: true,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
if (mimetype !== "application/epub+zip")
|
||||||
|
throw new Error(
|
||||||
|
"The root mimetype entry is not exactly application/epub+zip.",
|
||||||
|
);
|
||||||
|
const physicalFiles = entries
|
||||||
|
.filter((entry) => !entry.directory)
|
||||||
|
.toSorted((left, right) => left.offset - right.offset);
|
||||||
|
const mimetypeFirst = physicalFiles[0]?.filename === "mimetype";
|
||||||
|
const mimetypeStored = mimetypeEntry.compressionMethod === 0;
|
||||||
|
const provisional = { entryByPath };
|
||||||
|
const containerXml = await readEntryText(
|
||||||
|
provisional,
|
||||||
|
"META-INF/container.xml",
|
||||||
|
EPUB_LIMITS.xmlBytes,
|
||||||
|
);
|
||||||
|
const container = parseXml(containerXml, "META-INF/container.xml");
|
||||||
|
const rootfiles = elementsByLocalName(container, "rootfile")
|
||||||
|
.map((element) => element.getAttribute("full-path") ?? "")
|
||||||
|
.filter(Boolean);
|
||||||
|
if (!rootfiles.length)
|
||||||
|
throw new Error("container.xml does not declare a package rootfile.");
|
||||||
|
const packagePath = validateEntryPath(rootfiles[0] ?? "");
|
||||||
|
const packageXml = await readEntryText(
|
||||||
|
provisional,
|
||||||
|
packagePath,
|
||||||
|
EPUB_LIMITS.xmlBytes,
|
||||||
|
);
|
||||||
|
const parsed = parsePackageDocument(packageXml, packagePath);
|
||||||
|
const issues: EpubIssue[] = [];
|
||||||
|
if (rootfiles.length > 1)
|
||||||
|
issues.push({
|
||||||
|
severity: "info",
|
||||||
|
code: "multiple-renditions",
|
||||||
|
message: `${rootfiles.length} package rootfiles are present; version 0.1 opens the first rendition.`,
|
||||||
|
path: "META-INF/container.xml",
|
||||||
|
});
|
||||||
|
const book: EpubBook = {
|
||||||
|
file,
|
||||||
|
reader,
|
||||||
|
entries,
|
||||||
|
entryByPath,
|
||||||
|
package: parsed.package,
|
||||||
|
packageXml,
|
||||||
|
issues,
|
||||||
|
summary: {
|
||||||
|
filename: file.name,
|
||||||
|
fileSize: file.size,
|
||||||
|
entryCount: entries.length,
|
||||||
|
compressedBytes,
|
||||||
|
uncompressedBytes: totalUncompressed,
|
||||||
|
mimetypeFirst,
|
||||||
|
mimetypeStored,
|
||||||
|
encryptedResources:
|
||||||
|
entries.some((entry) => entry.encrypted) ||
|
||||||
|
entryByPath.has("META-INF/encryption.xml"),
|
||||||
|
},
|
||||||
|
};
|
||||||
|
if (book.package.nav?.path && entryByPath.has(book.package.nav.path)) {
|
||||||
|
try {
|
||||||
|
book.package.navigation = parseNavigationDocument(
|
||||||
|
await readEntryText(book, book.package.nav.path),
|
||||||
|
book.package.nav.path,
|
||||||
|
);
|
||||||
|
} catch (reason) {
|
||||||
|
issues.push({
|
||||||
|
severity: "error",
|
||||||
|
code: "invalid-navigation",
|
||||||
|
message:
|
||||||
|
reason instanceof Error
|
||||||
|
? reason.message
|
||||||
|
: "Navigation parsing failed.",
|
||||||
|
path: book.package.nav.path,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
} else if (
|
||||||
|
book.package.ncx?.path &&
|
||||||
|
entryByPath.has(book.package.ncx.path)
|
||||||
|
) {
|
||||||
|
try {
|
||||||
|
book.package.navigation = parseNcxDocument(
|
||||||
|
await readEntryText(book, book.package.ncx.path),
|
||||||
|
book.package.ncx.path,
|
||||||
|
);
|
||||||
|
} catch (reason) {
|
||||||
|
issues.push({
|
||||||
|
severity: "error",
|
||||||
|
code: "invalid-ncx",
|
||||||
|
message:
|
||||||
|
reason instanceof Error ? reason.message : "NCX parsing failed.",
|
||||||
|
path: book.package.ncx.path,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
issues.push(...(await validatePublication(book)));
|
||||||
|
return book;
|
||||||
|
} catch (reason) {
|
||||||
|
await reader.close().catch(() => undefined);
|
||||||
|
throw reason;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import { Uint8ArrayWriter } from "@zip.js/zip.js";
|
||||||
|
import { decodeXml } from "./xml";
|
||||||
|
import type { EpubBook } from "./types";
|
||||||
|
|
||||||
|
export const EPUB_LIMITS = {
|
||||||
|
fileBytes: 512 * 1024 * 1024,
|
||||||
|
entries: 20_000,
|
||||||
|
totalUncompressedBytes: 1024 * 1024 * 1024,
|
||||||
|
expansionRatio: 500,
|
||||||
|
xmlBytes: 16 * 1024 * 1024,
|
||||||
|
chapterBytes: 16 * 1024 * 1024,
|
||||||
|
resourceBytes: 64 * 1024 * 1024,
|
||||||
|
};
|
||||||
|
|
||||||
|
export async function readEntryBytes(
|
||||||
|
book: Pick<EpubBook, "entryByPath">,
|
||||||
|
path: string,
|
||||||
|
maximum = EPUB_LIMITS.resourceBytes,
|
||||||
|
): Promise<Uint8Array> {
|
||||||
|
const entry = book.entryByPath.get(path);
|
||||||
|
if (!entry || entry.directory)
|
||||||
|
throw new Error(`EPUB entry is missing: ${path}`);
|
||||||
|
if (entry.encrypted)
|
||||||
|
throw new Error(`ZIP-encrypted entry is unsupported: ${path}`);
|
||||||
|
if (entry.uncompressedSize > maximum)
|
||||||
|
throw new RangeError(
|
||||||
|
`${path} exceeds the ${Math.round(maximum / 1024 / 1024)} MiB extraction limit.`,
|
||||||
|
);
|
||||||
|
return entry.getData(new Uint8ArrayWriter(), {
|
||||||
|
checkSignature: true,
|
||||||
|
useWebWorkers: true,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function readEntryText(
|
||||||
|
book: Pick<EpubBook, "entryByPath">,
|
||||||
|
path: string,
|
||||||
|
maximum = EPUB_LIMITS.chapterBytes,
|
||||||
|
): Promise<string> {
|
||||||
|
return decodeXml(await readEntryBytes(book, path, maximum));
|
||||||
|
}
|
||||||
@@ -0,0 +1,181 @@
|
|||||||
|
import { BlobReader, BlobWriter, TextReader, ZipWriter } from "@zip.js/zip.js";
|
||||||
|
import { triggerBlobDownload } from "@add-ideas/toolbox-helpers";
|
||||||
|
import { readEntryText } from "./entries";
|
||||||
|
import type { EpubBook, EpubMetadata } from "./types";
|
||||||
|
import { elementsByLocalName, parseXml } from "./xml";
|
||||||
|
|
||||||
|
export interface MetadataPatch extends Omit<
|
||||||
|
EpubMetadata,
|
||||||
|
"creators" | "subjects"
|
||||||
|
> {
|
||||||
|
creators: string[];
|
||||||
|
subjects: string[];
|
||||||
|
}
|
||||||
|
export interface RebuildOptions {
|
||||||
|
metadata: MetadataPatch;
|
||||||
|
cover?: File;
|
||||||
|
normalizeTimestamps?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
const DC_NAMESPACE = "http://purl.org/dc/elements/1.1/";
|
||||||
|
|
||||||
|
function setMetadataValues(
|
||||||
|
document: XMLDocument,
|
||||||
|
metadataElement: Element,
|
||||||
|
localName: string,
|
||||||
|
values: string[],
|
||||||
|
): void {
|
||||||
|
for (const element of elementsByLocalName(metadataElement, localName))
|
||||||
|
element.remove();
|
||||||
|
for (const value of values.map((item) => item.trim()).filter(Boolean)) {
|
||||||
|
const element = document.createElementNS(DC_NAMESPACE, `dc:${localName}`);
|
||||||
|
element.textContent = value;
|
||||||
|
metadataElement.append(element);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function patchPackageMetadata(
|
||||||
|
packageXml: string,
|
||||||
|
metadata: MetadataPatch,
|
||||||
|
coverMediaType?: string,
|
||||||
|
coverId?: string,
|
||||||
|
): string {
|
||||||
|
const document = parseXml(packageXml, "package document");
|
||||||
|
const metadataElement = elementsByLocalName(
|
||||||
|
document.documentElement,
|
||||||
|
"metadata",
|
||||||
|
)[0];
|
||||||
|
if (!metadataElement) throw new Error("Package metadata element is missing.");
|
||||||
|
setMetadataValues(document, metadataElement, "title", [metadata.title]);
|
||||||
|
setMetadataValues(document, metadataElement, "creator", metadata.creators);
|
||||||
|
setMetadataValues(document, metadataElement, "language", [metadata.language]);
|
||||||
|
setMetadataValues(document, metadataElement, "identifier", [
|
||||||
|
metadata.identifier,
|
||||||
|
]);
|
||||||
|
setMetadataValues(document, metadataElement, "publisher", [
|
||||||
|
metadata.publisher,
|
||||||
|
]);
|
||||||
|
setMetadataValues(document, metadataElement, "date", [metadata.date]);
|
||||||
|
setMetadataValues(document, metadataElement, "description", [
|
||||||
|
metadata.description,
|
||||||
|
]);
|
||||||
|
setMetadataValues(document, metadataElement, "rights", [metadata.rights]);
|
||||||
|
setMetadataValues(document, metadataElement, "subject", metadata.subjects);
|
||||||
|
if (coverMediaType && coverId) {
|
||||||
|
const coverItem = elementsByLocalName(
|
||||||
|
document.documentElement,
|
||||||
|
"item",
|
||||||
|
).find((item) => item.getAttribute("id") === coverId);
|
||||||
|
coverItem?.setAttribute("media-type", coverMediaType);
|
||||||
|
}
|
||||||
|
const serialized = new XMLSerializer().serializeToString(document);
|
||||||
|
return serialized.startsWith("<?xml")
|
||||||
|
? serialized
|
||||||
|
: `<?xml version="1.0" encoding="UTF-8"?>\n${serialized}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function coverType(file: File): string {
|
||||||
|
if (
|
||||||
|
["image/jpeg", "image/png", "image/webp", "image/svg+xml"].includes(
|
||||||
|
file.type,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return file.type;
|
||||||
|
throw new Error(
|
||||||
|
"Replacement cover must be JPEG, PNG, WebP, or SVG with an explicit browser MIME type.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function rebuildEpub(
|
||||||
|
book: EpubBook,
|
||||||
|
options: RebuildOptions,
|
||||||
|
onProgress?: (message: string) => void,
|
||||||
|
): Promise<{ blob: Blob; changes: string[]; packageXml: string }> {
|
||||||
|
if (book.summary.encryptedResources)
|
||||||
|
throw new Error(
|
||||||
|
"Rebuilding is disabled when encryption or DRM metadata is present; copying may invalidate protection or obfuscation metadata.",
|
||||||
|
);
|
||||||
|
if (options.cover && !book.package.cover)
|
||||||
|
throw new Error("This publication has no declared cover item to replace.");
|
||||||
|
const replacementType = options.cover ? coverType(options.cover) : undefined;
|
||||||
|
const packageXml = patchPackageMetadata(
|
||||||
|
book.packageXml,
|
||||||
|
options.metadata,
|
||||||
|
replacementType,
|
||||||
|
book.package.cover?.id,
|
||||||
|
);
|
||||||
|
const writer = new ZipWriter(new BlobWriter("application/epub+zip"));
|
||||||
|
const fixedDate = new Date("1980-01-01T00:00:00.000Z");
|
||||||
|
const changes = [
|
||||||
|
"Rewrote package metadata",
|
||||||
|
"Placed an uncompressed mimetype entry first",
|
||||||
|
];
|
||||||
|
await writer.add("mimetype", new TextReader("application/epub+zip"), {
|
||||||
|
level: 0,
|
||||||
|
lastModDate: options.normalizeTimestamps ? fixedDate : undefined,
|
||||||
|
});
|
||||||
|
const entries = book.entries
|
||||||
|
.filter((entry) => !entry.directory && entry.filename !== "mimetype")
|
||||||
|
.toSorted((left, right) => left.filename.localeCompare(right.filename));
|
||||||
|
for (const [index, entry] of entries.entries()) {
|
||||||
|
if (entry.directory) continue;
|
||||||
|
onProgress?.(`Writing ${index + 1} / ${entries.length}: ${entry.filename}`);
|
||||||
|
const lastModDate = options.normalizeTimestamps
|
||||||
|
? fixedDate
|
||||||
|
: entry.lastModDate;
|
||||||
|
if (entry.filename === book.package.packagePath)
|
||||||
|
await writer.add(entry.filename, new TextReader(packageXml), {
|
||||||
|
level: 6,
|
||||||
|
lastModDate,
|
||||||
|
});
|
||||||
|
else if (options.cover && entry.filename === book.package.cover?.path) {
|
||||||
|
await writer.add(entry.filename, new BlobReader(options.cover), {
|
||||||
|
level: 6,
|
||||||
|
lastModDate,
|
||||||
|
});
|
||||||
|
changes.push(`Replaced cover bytes at ${entry.filename}`);
|
||||||
|
} else {
|
||||||
|
const blob = await entry.getData(new BlobWriter(), {
|
||||||
|
checkSignature: true,
|
||||||
|
useWebWorkers: true,
|
||||||
|
});
|
||||||
|
await writer.add(entry.filename, new BlobReader(blob), {
|
||||||
|
level: entry.compressionMethod === 0 ? 0 : 6,
|
||||||
|
lastModDate,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const blob = await writer.close();
|
||||||
|
return { blob, changes, packageXml };
|
||||||
|
}
|
||||||
|
|
||||||
|
export function downloadJson(value: unknown, filename: string): void {
|
||||||
|
triggerBlobDownload(
|
||||||
|
new Blob([JSON.stringify(value, null, 2)], { type: "application/json" }),
|
||||||
|
filename,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function exportPlainText(book: EpubBook): Promise<Blob> {
|
||||||
|
const sections: string[] = [];
|
||||||
|
let total = 0;
|
||||||
|
for (const spine of book.package.spine) {
|
||||||
|
if (!spine.item || !/xhtml|html/iu.test(spine.item.mediaType)) continue;
|
||||||
|
const source = await readEntryText(book, spine.item.path, 4 * 1024 * 1024);
|
||||||
|
const document = new DOMParser().parseFromString(source, "text/html");
|
||||||
|
document
|
||||||
|
.querySelectorAll("script, style, iframe, object, embed")
|
||||||
|
.forEach((element) => element.remove());
|
||||||
|
const value = (document.body.textContent ?? "")
|
||||||
|
.replace(/[ \t]+/gu, " ")
|
||||||
|
.replace(/\n{3,}/gu, "\n\n")
|
||||||
|
.trim();
|
||||||
|
total += value.length;
|
||||||
|
if (total > 32 * 1024 * 1024)
|
||||||
|
throw new RangeError("Plain-text export exceeds the 32 MiB text limit.");
|
||||||
|
sections.push(`# ${spine.item.id}\n\n${value}`);
|
||||||
|
}
|
||||||
|
return new Blob([sections.join("\n\n")], {
|
||||||
|
type: "text/plain;charset=utf-8",
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,181 @@
|
|||||||
|
import type {
|
||||||
|
EpubMetadata,
|
||||||
|
EpubPackage,
|
||||||
|
ManifestItem,
|
||||||
|
NavigationItem,
|
||||||
|
SpineItem,
|
||||||
|
} from "./types";
|
||||||
|
import { directoryOf, resolvePackageHref, splitReference } from "./paths";
|
||||||
|
import {
|
||||||
|
directChildrenByLocalName,
|
||||||
|
elementsByLocalName,
|
||||||
|
parseXml,
|
||||||
|
} from "./xml";
|
||||||
|
|
||||||
|
function text(element: Element | undefined): string {
|
||||||
|
return element?.textContent?.trim() ?? "";
|
||||||
|
}
|
||||||
|
function firstDirect(parent: Element, name: string): Element | undefined {
|
||||||
|
return directChildrenByLocalName(parent, name)[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function parsePackageDocument(
|
||||||
|
packageXml: string,
|
||||||
|
packagePath: string,
|
||||||
|
): { package: EpubPackage; document: XMLDocument } {
|
||||||
|
const document = parseXml(packageXml, packagePath);
|
||||||
|
const root = document.documentElement;
|
||||||
|
if (root.localName !== "package")
|
||||||
|
throw new Error("The rootfile is not an EPUB package document.");
|
||||||
|
const metadataElement = firstDirect(root, "metadata");
|
||||||
|
const manifestElement = firstDirect(root, "manifest");
|
||||||
|
const spineElement = firstDirect(root, "spine");
|
||||||
|
if (!metadataElement || !manifestElement || !spineElement)
|
||||||
|
throw new Error(
|
||||||
|
"The package document must contain metadata, manifest, and spine elements.",
|
||||||
|
);
|
||||||
|
const metadata: EpubMetadata = {
|
||||||
|
title: text(elementsByLocalName(metadataElement, "title")[0]),
|
||||||
|
creators: elementsByLocalName(metadataElement, "creator")
|
||||||
|
.map((item) => text(item))
|
||||||
|
.filter(Boolean),
|
||||||
|
language: text(elementsByLocalName(metadataElement, "language")[0]),
|
||||||
|
identifier: text(elementsByLocalName(metadataElement, "identifier")[0]),
|
||||||
|
publisher: text(elementsByLocalName(metadataElement, "publisher")[0]),
|
||||||
|
date: text(elementsByLocalName(metadataElement, "date")[0]),
|
||||||
|
description: text(elementsByLocalName(metadataElement, "description")[0]),
|
||||||
|
rights: text(elementsByLocalName(metadataElement, "rights")[0]),
|
||||||
|
subjects: elementsByLocalName(metadataElement, "subject")
|
||||||
|
.map((item) => text(item))
|
||||||
|
.filter(Boolean),
|
||||||
|
};
|
||||||
|
const packageDirectory = directoryOf(packagePath);
|
||||||
|
const manifest: ManifestItem[] = directChildrenByLocalName(
|
||||||
|
manifestElement,
|
||||||
|
"item",
|
||||||
|
).map((element) => {
|
||||||
|
const href = element.getAttribute("href") ?? "";
|
||||||
|
return {
|
||||||
|
id: element.getAttribute("id") ?? "",
|
||||||
|
href,
|
||||||
|
path: resolvePackageHref(packagePath, href) ?? "",
|
||||||
|
mediaType: element.getAttribute("media-type") ?? "",
|
||||||
|
properties: (element.getAttribute("properties") ?? "")
|
||||||
|
.split(/\s+/u)
|
||||||
|
.filter(Boolean),
|
||||||
|
fallback: element.getAttribute("fallback") ?? undefined,
|
||||||
|
mediaOverlay: element.getAttribute("media-overlay") ?? undefined,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
const byId = new Map(manifest.map((item) => [item.id, item]));
|
||||||
|
const spine: SpineItem[] = directChildrenByLocalName(
|
||||||
|
spineElement,
|
||||||
|
"itemref",
|
||||||
|
).map((element) => {
|
||||||
|
const idref = element.getAttribute("idref") ?? "";
|
||||||
|
return {
|
||||||
|
idref,
|
||||||
|
linear: element.getAttribute("linear") !== "no",
|
||||||
|
properties: (element.getAttribute("properties") ?? "")
|
||||||
|
.split(/\s+/u)
|
||||||
|
.filter(Boolean),
|
||||||
|
item: byId.get(idref),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
const coverId = elementsByLocalName(metadataElement, "meta")
|
||||||
|
.find((element) => element.getAttribute("name") === "cover")
|
||||||
|
?.getAttribute("content");
|
||||||
|
const cover =
|
||||||
|
manifest.find((item) => item.properties.includes("cover-image")) ??
|
||||||
|
(coverId ? byId.get(coverId) : undefined);
|
||||||
|
const nav = manifest.find((item) => item.properties.includes("nav"));
|
||||||
|
const ncxId = spineElement.getAttribute("toc") ?? undefined;
|
||||||
|
const ncx =
|
||||||
|
(ncxId ? byId.get(ncxId) : undefined) ??
|
||||||
|
manifest.find((item) => item.mediaType === "application/x-dtbncx+xml");
|
||||||
|
return {
|
||||||
|
package: {
|
||||||
|
version: root.getAttribute("version") ?? "",
|
||||||
|
uniqueIdentifier: root.getAttribute("unique-identifier") ?? undefined,
|
||||||
|
packagePath,
|
||||||
|
packageDirectory,
|
||||||
|
metadata,
|
||||||
|
manifest,
|
||||||
|
spine,
|
||||||
|
navigation: [],
|
||||||
|
cover,
|
||||||
|
nav,
|
||||||
|
ncx,
|
||||||
|
},
|
||||||
|
document,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function navigationChildren(list: Element, basePath: string): NavigationItem[] {
|
||||||
|
return directChildrenByLocalName(list, "li").map((item) => {
|
||||||
|
const anchor = directChildrenByLocalName(item, "a")[0];
|
||||||
|
const labelNode = anchor ?? directChildrenByLocalName(item, "span")[0];
|
||||||
|
const href = anchor?.getAttribute("href") ?? "";
|
||||||
|
const nested = directChildrenByLocalName(item, "ol")[0];
|
||||||
|
let path: string | undefined;
|
||||||
|
try {
|
||||||
|
path = href ? resolvePackageHref(basePath, href) : undefined;
|
||||||
|
} catch {
|
||||||
|
path = undefined;
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
label: text(labelNode) || "Untitled",
|
||||||
|
href,
|
||||||
|
path,
|
||||||
|
fragment: splitReference(href).fragment || undefined,
|
||||||
|
children: nested ? navigationChildren(nested, basePath) : [],
|
||||||
|
};
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function parseNavigationDocument(
|
||||||
|
xml: string,
|
||||||
|
path: string,
|
||||||
|
): NavigationItem[] {
|
||||||
|
const document = parseXml(xml, path);
|
||||||
|
const navs = elementsByLocalName(document, "nav");
|
||||||
|
const toc =
|
||||||
|
navs.find((element) =>
|
||||||
|
(
|
||||||
|
element.getAttribute("epub:type") ??
|
||||||
|
element.getAttributeNS("http://www.idpf.org/2007/ops", "type") ??
|
||||||
|
""
|
||||||
|
)
|
||||||
|
.split(/\s+/u)
|
||||||
|
.includes("toc"),
|
||||||
|
) ?? navs[0];
|
||||||
|
if (!toc) return [];
|
||||||
|
const list = elementsByLocalName(toc, "ol")[0];
|
||||||
|
return list ? navigationChildren(list, path) : [];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function parseNcxDocument(xml: string, path: string): NavigationItem[] {
|
||||||
|
const document = parseXml(xml, path);
|
||||||
|
const navMap = elementsByLocalName(document, "navMap")[0];
|
||||||
|
if (!navMap) return [];
|
||||||
|
const parsePoints = (parent: Element): NavigationItem[] =>
|
||||||
|
directChildrenByLocalName(parent, "navPoint").map((point) => {
|
||||||
|
const label = text(elementsByLocalName(point, "text")[0]) || "Untitled";
|
||||||
|
const href =
|
||||||
|
elementsByLocalName(point, "content")[0]?.getAttribute("src") ?? "";
|
||||||
|
let target: string | undefined;
|
||||||
|
try {
|
||||||
|
target = href ? resolvePackageHref(path, href) : undefined;
|
||||||
|
} catch {
|
||||||
|
target = undefined;
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
label,
|
||||||
|
href,
|
||||||
|
path: target,
|
||||||
|
fragment: splitReference(href).fragment || undefined,
|
||||||
|
children: parsePoints(point),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
return parsePoints(navMap);
|
||||||
|
}
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
export function isExternalReference(value: string): boolean {
|
||||||
|
return /^(?:[a-z][a-z0-9+.-]*:|\/\/)/iu.test(value.trim());
|
||||||
|
}
|
||||||
|
|
||||||
|
export function validateEntryPath(input: string): string {
|
||||||
|
if (
|
||||||
|
!input ||
|
||||||
|
input.includes("\0") ||
|
||||||
|
input.includes("\\") ||
|
||||||
|
input.startsWith("/") ||
|
||||||
|
/^[A-Za-z]:/u.test(input)
|
||||||
|
)
|
||||||
|
throw new Error(`Unsafe archive path: ${input || "(empty)"}`);
|
||||||
|
const parts = input.split("/");
|
||||||
|
if (parts.some((part) => part === ".." || part === "."))
|
||||||
|
throw new Error(`Archive path contains traversal segments: ${input}`);
|
||||||
|
return input;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function directoryOf(path: string): string {
|
||||||
|
const index = path.lastIndexOf("/");
|
||||||
|
return index < 0 ? "" : path.slice(0, index + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function splitReference(input: string): {
|
||||||
|
pathname: string;
|
||||||
|
fragment: string;
|
||||||
|
} {
|
||||||
|
const hash = input.indexOf("#");
|
||||||
|
const query = input.indexOf("?");
|
||||||
|
const end = Math.min(
|
||||||
|
hash < 0 ? input.length : hash,
|
||||||
|
query < 0 ? input.length : query,
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
pathname: input.slice(0, end),
|
||||||
|
fragment: hash < 0 ? "" : input.slice(hash + 1),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function resolvePackageHref(
|
||||||
|
basePath: string,
|
||||||
|
href: string,
|
||||||
|
): string | undefined {
|
||||||
|
const value = href.trim();
|
||||||
|
if (!value || isExternalReference(value)) return undefined;
|
||||||
|
const { pathname } = splitReference(value);
|
||||||
|
let decoded: string;
|
||||||
|
try {
|
||||||
|
decoded = decodeURIComponent(pathname);
|
||||||
|
} catch {
|
||||||
|
throw new Error(`Invalid percent-encoding in href: ${href}`);
|
||||||
|
}
|
||||||
|
if (!decoded) return basePath;
|
||||||
|
if (decoded.includes("\\") || decoded.startsWith("/"))
|
||||||
|
throw new Error(`Unsafe absolute or backslash href: ${href}`);
|
||||||
|
const stack = directoryOf(basePath).split("/").filter(Boolean);
|
||||||
|
for (const part of decoded.split("/")) {
|
||||||
|
if (!part || part === ".") continue;
|
||||||
|
if (part === "..") {
|
||||||
|
if (!stack.length)
|
||||||
|
throw new Error(`Href escapes the EPUB package: ${href}`);
|
||||||
|
stack.pop();
|
||||||
|
} else stack.push(part);
|
||||||
|
}
|
||||||
|
return stack.join("/");
|
||||||
|
}
|
||||||
@@ -0,0 +1,161 @@
|
|||||||
|
import DOMPurify from "dompurify";
|
||||||
|
import { readEntryBytes, readEntryText } from "./entries";
|
||||||
|
import { isExternalReference, resolvePackageHref } from "./paths";
|
||||||
|
import type { EpubBook, NavigationItem, RenderedChapter } from "./types";
|
||||||
|
|
||||||
|
const readerStyle = `
|
||||||
|
:root { color-scheme: light dark; font-family: ui-serif, Georgia, serif; line-height: 1.62; }
|
||||||
|
body { max-width: 48rem; margin: 0 auto; padding: 1.4rem; overflow-wrap: anywhere; }
|
||||||
|
img, svg { max-width: 100%; height: auto; }
|
||||||
|
table { max-width: 100%; border-collapse: collapse; overflow-wrap: anywhere; }
|
||||||
|
th, td { padding: .3rem; border: 1px solid currentColor; }
|
||||||
|
pre { max-width: 100%; overflow: auto; white-space: pre-wrap; }
|
||||||
|
a { color: inherit; text-decoration: underline dotted; }
|
||||||
|
`;
|
||||||
|
|
||||||
|
function flattenNavigation(items: NavigationItem[]): NavigationItem[] {
|
||||||
|
return items.flatMap((item) => [item, ...flattenNavigation(item.children)]);
|
||||||
|
}
|
||||||
|
|
||||||
|
function safeInlineStyle(value: string): string {
|
||||||
|
return value
|
||||||
|
.replace(/@import[^;]+;?/giu, "")
|
||||||
|
.replace(/url\s*\([^)]*\)/giu, "none")
|
||||||
|
.replace(/expression\s*\([^)]*\)/giu, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function renderChapter(
|
||||||
|
book: EpubBook,
|
||||||
|
path: string,
|
||||||
|
): Promise<RenderedChapter> {
|
||||||
|
const item = book.package.manifest.find(
|
||||||
|
(candidate) => candidate.path === path,
|
||||||
|
);
|
||||||
|
if (
|
||||||
|
!item ||
|
||||||
|
!/^(?:application\/xhtml\+xml|text\/html|image\/svg\+xml)$/iu.test(
|
||||||
|
item.mediaType,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
throw new Error(
|
||||||
|
"Only XHTML, HTML, and SVG spine documents can be rendered.",
|
||||||
|
);
|
||||||
|
const source = await readEntryText(book, path);
|
||||||
|
const sanitized = DOMPurify.sanitize(source, {
|
||||||
|
WHOLE_DOCUMENT: true,
|
||||||
|
USE_PROFILES: { html: true, svg: true, svgFilters: false },
|
||||||
|
FORBID_TAGS: [
|
||||||
|
"script",
|
||||||
|
"iframe",
|
||||||
|
"object",
|
||||||
|
"embed",
|
||||||
|
"form",
|
||||||
|
"input",
|
||||||
|
"button",
|
||||||
|
"textarea",
|
||||||
|
"select",
|
||||||
|
"base",
|
||||||
|
"meta",
|
||||||
|
"link",
|
||||||
|
],
|
||||||
|
FORBID_ATTR: ["srcset", "formaction", "ping"],
|
||||||
|
});
|
||||||
|
const document = new DOMParser().parseFromString(
|
||||||
|
String(sanitized),
|
||||||
|
"text/html",
|
||||||
|
);
|
||||||
|
for (const element of [...document.querySelectorAll<HTMLElement>("[style]")])
|
||||||
|
element.setAttribute(
|
||||||
|
"style",
|
||||||
|
safeInlineStyle(element.getAttribute("style") ?? ""),
|
||||||
|
);
|
||||||
|
for (const style of [...document.querySelectorAll("style")])
|
||||||
|
style.textContent = safeInlineStyle(style.textContent ?? "");
|
||||||
|
for (const anchor of [
|
||||||
|
...document.querySelectorAll<HTMLAnchorElement>("a[href]"),
|
||||||
|
]) {
|
||||||
|
const original = anchor.getAttribute("href") ?? "";
|
||||||
|
anchor.setAttribute("data-epub-href", original);
|
||||||
|
anchor.setAttribute("href", "#");
|
||||||
|
anchor.removeAttribute("target");
|
||||||
|
anchor.title = original
|
||||||
|
? `EPUB link disabled in safe reader: ${original}`
|
||||||
|
: "EPUB link";
|
||||||
|
}
|
||||||
|
const objectUrls: string[] = [];
|
||||||
|
const resourceNodes: Array<{ element: Element; attribute: string }> = [
|
||||||
|
...[...document.querySelectorAll("img[src]")].map((element) => ({
|
||||||
|
element,
|
||||||
|
attribute: "src",
|
||||||
|
})),
|
||||||
|
...[...document.querySelectorAll("svg image[href]")].map((element) => ({
|
||||||
|
element,
|
||||||
|
attribute: "href",
|
||||||
|
})),
|
||||||
|
...[...document.querySelectorAll("svg image[xlink\\:href]")].map(
|
||||||
|
(element) => ({ element, attribute: "xlink:href" }),
|
||||||
|
),
|
||||||
|
];
|
||||||
|
for (const { element, attribute } of resourceNodes) {
|
||||||
|
const reference = element.getAttribute(attribute) ?? "";
|
||||||
|
if (
|
||||||
|
!reference ||
|
||||||
|
reference.startsWith("data:") ||
|
||||||
|
isExternalReference(reference)
|
||||||
|
) {
|
||||||
|
if (isExternalReference(reference)) element.removeAttribute(attribute);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const target = resolvePackageHref(path, reference);
|
||||||
|
const resource = target
|
||||||
|
? book.package.manifest.find((candidate) => candidate.path === target)
|
||||||
|
: undefined;
|
||||||
|
if (
|
||||||
|
!target ||
|
||||||
|
!resource ||
|
||||||
|
!resource.mediaType.startsWith("image/") ||
|
||||||
|
!book.entryByPath.has(target)
|
||||||
|
) {
|
||||||
|
element.removeAttribute(attribute);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
const bytes = await readEntryBytes(book, target, 25 * 1024 * 1024);
|
||||||
|
const url = URL.createObjectURL(
|
||||||
|
new Blob([bytes as BlobPart], { type: resource.mediaType }),
|
||||||
|
);
|
||||||
|
objectUrls.push(url);
|
||||||
|
element.setAttribute(attribute, url);
|
||||||
|
} catch {
|
||||||
|
element.removeAttribute(attribute);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const csp = document.createElement("meta");
|
||||||
|
csp.httpEquiv = "Content-Security-Policy";
|
||||||
|
csp.content =
|
||||||
|
"default-src 'none'; img-src data: blob:; style-src 'unsafe-inline'; font-src data: blob:; media-src blob: data:; form-action 'none'; base-uri 'none'";
|
||||||
|
const style = document.createElement("style");
|
||||||
|
style.textContent = readerStyle;
|
||||||
|
document.head.prepend(csp, style);
|
||||||
|
const title =
|
||||||
|
document.title.trim() ||
|
||||||
|
flattenNavigation(book.package.navigation).find(
|
||||||
|
(entry) => entry.path === path,
|
||||||
|
)?.label ||
|
||||||
|
item.id ||
|
||||||
|
path;
|
||||||
|
const text = (document.body.textContent ?? "").replace(/\s+/gu, " ").trim();
|
||||||
|
return {
|
||||||
|
path,
|
||||||
|
html: `<!doctype html>\n${document.documentElement.outerHTML}`,
|
||||||
|
title,
|
||||||
|
objectUrls,
|
||||||
|
text,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function revokeRenderedChapter(
|
||||||
|
chapter: RenderedChapter | undefined,
|
||||||
|
): void {
|
||||||
|
for (const url of chapter?.objectUrls ?? []) URL.revokeObjectURL(url);
|
||||||
|
}
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
import type { Entry, ZipReader } from "@zip.js/zip.js";
|
||||||
|
|
||||||
|
export type IssueSeverity = "error" | "warning" | "info";
|
||||||
|
export interface EpubIssue {
|
||||||
|
severity: IssueSeverity;
|
||||||
|
code: string;
|
||||||
|
message: string;
|
||||||
|
path?: string;
|
||||||
|
}
|
||||||
|
export interface EpubMetadata {
|
||||||
|
title: string;
|
||||||
|
creators: string[];
|
||||||
|
language: string;
|
||||||
|
identifier: string;
|
||||||
|
publisher: string;
|
||||||
|
date: string;
|
||||||
|
description: string;
|
||||||
|
rights: string;
|
||||||
|
subjects: string[];
|
||||||
|
}
|
||||||
|
export interface ManifestItem {
|
||||||
|
id: string;
|
||||||
|
href: string;
|
||||||
|
path: string;
|
||||||
|
mediaType: string;
|
||||||
|
properties: string[];
|
||||||
|
fallback?: string;
|
||||||
|
mediaOverlay?: string;
|
||||||
|
}
|
||||||
|
export interface SpineItem {
|
||||||
|
idref: string;
|
||||||
|
linear: boolean;
|
||||||
|
properties: string[];
|
||||||
|
item?: ManifestItem;
|
||||||
|
}
|
||||||
|
export interface NavigationItem {
|
||||||
|
label: string;
|
||||||
|
href: string;
|
||||||
|
path?: string;
|
||||||
|
fragment?: string;
|
||||||
|
children: NavigationItem[];
|
||||||
|
}
|
||||||
|
export interface EpubPackage {
|
||||||
|
version: string;
|
||||||
|
uniqueIdentifier?: string;
|
||||||
|
packagePath: string;
|
||||||
|
packageDirectory: string;
|
||||||
|
metadata: EpubMetadata;
|
||||||
|
manifest: ManifestItem[];
|
||||||
|
spine: SpineItem[];
|
||||||
|
navigation: NavigationItem[];
|
||||||
|
cover?: ManifestItem;
|
||||||
|
nav?: ManifestItem;
|
||||||
|
ncx?: ManifestItem;
|
||||||
|
}
|
||||||
|
export interface EpubEntrySummary {
|
||||||
|
path: string;
|
||||||
|
compressedSize: number;
|
||||||
|
uncompressedSize: number;
|
||||||
|
mediaType?: string;
|
||||||
|
directory: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EpubBook {
|
||||||
|
file: File;
|
||||||
|
reader: ZipReader<Blob>;
|
||||||
|
entries: Entry[];
|
||||||
|
entryByPath: Map<string, Entry>;
|
||||||
|
package: EpubPackage;
|
||||||
|
packageXml: string;
|
||||||
|
issues: EpubIssue[];
|
||||||
|
summary: {
|
||||||
|
filename: string;
|
||||||
|
fileSize: number;
|
||||||
|
entryCount: number;
|
||||||
|
compressedBytes: number;
|
||||||
|
uncompressedBytes: number;
|
||||||
|
mimetypeFirst: boolean;
|
||||||
|
mimetypeStored: boolean;
|
||||||
|
encryptedResources: boolean;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RenderedChapter {
|
||||||
|
path: string;
|
||||||
|
html: string;
|
||||||
|
title: string;
|
||||||
|
objectUrls: string[];
|
||||||
|
text: string;
|
||||||
|
}
|
||||||
@@ -0,0 +1,340 @@
|
|||||||
|
import { readEntryText } from "./entries";
|
||||||
|
import { isExternalReference, resolvePackageHref } from "./paths";
|
||||||
|
import type { EpubBook, EpubIssue } from "./types";
|
||||||
|
import { parseXml } from "./xml";
|
||||||
|
|
||||||
|
function issue(
|
||||||
|
severity: EpubIssue["severity"],
|
||||||
|
code: string,
|
||||||
|
message: string,
|
||||||
|
path?: string,
|
||||||
|
): EpubIssue {
|
||||||
|
return { severity, code, message, path };
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function validatePublication(
|
||||||
|
book: EpubBook,
|
||||||
|
): Promise<EpubIssue[]> {
|
||||||
|
const result: EpubIssue[] = [];
|
||||||
|
if (!book.summary.mimetypeFirst)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"mimetype-not-first",
|
||||||
|
"The mimetype entry is not physically first; rebuilding can normalize this.",
|
||||||
|
"mimetype",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.summary.mimetypeStored)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"mimetype-compressed",
|
||||||
|
"The mimetype entry is compressed; EPUB requires it to be stored without compression.",
|
||||||
|
"mimetype",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.entryByPath.has("META-INF/container.xml"))
|
||||||
|
result.push(
|
||||||
|
issue("error", "missing-container", "META-INF/container.xml is missing."),
|
||||||
|
);
|
||||||
|
if (!book.package.version)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"missing-version",
|
||||||
|
"The package element has no EPUB version.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.package.metadata.title)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"missing-title",
|
||||||
|
"dc:title is missing or empty.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.package.metadata.identifier)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"missing-identifier",
|
||||||
|
"dc:identifier is missing or empty.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.package.metadata.language)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"missing-language",
|
||||||
|
"dc:language is missing or empty.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.package.spine.length)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"empty-spine",
|
||||||
|
"The publication spine is empty.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.package.nav && !book.package.ncx)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"missing-navigation",
|
||||||
|
"No EPUB navigation document or NCX was declared.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (!book.package.cover)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"info",
|
||||||
|
"missing-cover",
|
||||||
|
"No cover-image property or EPUB 2 cover metadata was found.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (book.entryByPath.has("META-INF/encryption.xml"))
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"encrypted-resources",
|
||||||
|
"META-INF/encryption.xml is present. Font obfuscation may be valid; DRM-protected content is detected but not bypassed.",
|
||||||
|
"META-INF/encryption.xml",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
if (book.entryByPath.has("META-INF/signatures.xml"))
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"info",
|
||||||
|
"signatures-unverified",
|
||||||
|
"Publication signatures are present but are not verified in v0.1.",
|
||||||
|
"META-INF/signatures.xml",
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
const ids = new Set<string>();
|
||||||
|
const manifestPaths = new Set<string>();
|
||||||
|
for (const item of book.package.manifest) {
|
||||||
|
if (!item.id)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"manifest-id-missing",
|
||||||
|
"A manifest item has no id.",
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
else if (ids.has(item.id))
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"duplicate-manifest-id",
|
||||||
|
`Duplicate manifest id: ${item.id}`,
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
ids.add(item.id);
|
||||||
|
if (!item.href || !item.path) {
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"invalid-manifest-href",
|
||||||
|
`Manifest item ${item.id || "(without id)"} has an empty or external href.`,
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (manifestPaths.has(item.path))
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"duplicate-manifest-target",
|
||||||
|
`More than one manifest item targets ${item.path}.`,
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
manifestPaths.add(item.path);
|
||||||
|
if (!book.entryByPath.has(item.path))
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"missing-manifest-resource",
|
||||||
|
`Manifest resource is missing: ${item.path}`,
|
||||||
|
item.path,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for (const spine of book.package.spine) {
|
||||||
|
if (!spine.item)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"missing-spine-item",
|
||||||
|
`Spine idref does not exist in the manifest: ${spine.idref}`,
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
else if (
|
||||||
|
!/^(?:application\/xhtml\+xml|text\/html)$/iu.test(spine.item.mediaType)
|
||||||
|
)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"non-html-spine",
|
||||||
|
`Spine item ${spine.idref} has media type ${spine.item.mediaType || "(empty)"}.`,
|
||||||
|
spine.item.path,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const linkedTargets = new Set<string>();
|
||||||
|
let inspectedBytes = 0;
|
||||||
|
let inspectedDocuments = 0;
|
||||||
|
for (const item of book.package.manifest) {
|
||||||
|
if (
|
||||||
|
!/^(?:application\/xhtml\+xml|image\/svg\+xml|text\/html)$/iu.test(
|
||||||
|
item.mediaType,
|
||||||
|
) ||
|
||||||
|
!book.entryByPath.has(item.path)
|
||||||
|
)
|
||||||
|
continue;
|
||||||
|
const entry = book.entryByPath.get(item.path);
|
||||||
|
if (
|
||||||
|
!entry ||
|
||||||
|
entry.directory ||
|
||||||
|
entry.uncompressedSize > 4 * 1024 * 1024 ||
|
||||||
|
inspectedBytes + entry.uncompressedSize > 32 * 1024 * 1024 ||
|
||||||
|
inspectedDocuments >= 500
|
||||||
|
)
|
||||||
|
continue;
|
||||||
|
inspectedBytes += entry.uncompressedSize;
|
||||||
|
inspectedDocuments += 1;
|
||||||
|
try {
|
||||||
|
const document = parseXml(
|
||||||
|
await readEntryText(book, item.path, 4 * 1024 * 1024),
|
||||||
|
item.path,
|
||||||
|
);
|
||||||
|
if (document.querySelector("script, iframe, object, embed, form"))
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"active-content",
|
||||||
|
"Active or interactive content is present and will be removed by the safe reader.",
|
||||||
|
item.path,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
for (const element of [
|
||||||
|
...document.querySelectorAll("[href], [src], [poster]"),
|
||||||
|
]) {
|
||||||
|
const attribute = element.hasAttribute("href")
|
||||||
|
? "href"
|
||||||
|
: element.hasAttribute("src")
|
||||||
|
? "src"
|
||||||
|
: "poster";
|
||||||
|
const reference = element.getAttribute(attribute)?.trim() ?? "";
|
||||||
|
if (
|
||||||
|
!reference ||
|
||||||
|
reference.startsWith("#") ||
|
||||||
|
reference.startsWith("data:")
|
||||||
|
)
|
||||||
|
continue;
|
||||||
|
if (isExternalReference(reference)) {
|
||||||
|
if (attribute !== "href" || element.localName !== "a")
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"warning",
|
||||||
|
"external-resource",
|
||||||
|
`External ${attribute} is blocked by the safe reader: ${reference.slice(0, 180)}`,
|
||||||
|
item.path,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const target = resolvePackageHref(item.path, reference);
|
||||||
|
if (target) {
|
||||||
|
linkedTargets.add(target);
|
||||||
|
if (!book.entryByPath.has(target))
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"broken-link",
|
||||||
|
`Referenced resource is missing: ${target}`,
|
||||||
|
item.path,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
} catch (reason) {
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"unsafe-link",
|
||||||
|
reason instanceof Error
|
||||||
|
? reason.message
|
||||||
|
: "Unsafe relative link.",
|
||||||
|
item.path,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (reason) {
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"error",
|
||||||
|
"invalid-content-document",
|
||||||
|
reason instanceof Error
|
||||||
|
? reason.message
|
||||||
|
: "Content document parsing failed.",
|
||||||
|
item.path,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (
|
||||||
|
inspectedDocuments <
|
||||||
|
book.package.manifest.filter((item) =>
|
||||||
|
/xhtml|html|svg/iu.test(item.mediaType),
|
||||||
|
).length
|
||||||
|
)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"info",
|
||||||
|
"link-scan-bounded",
|
||||||
|
`Link scan inspected ${inspectedDocuments} documents and ${inspectedBytes.toLocaleString()} bytes; oversized or excess documents were skipped.`,
|
||||||
|
book.package.packagePath,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
|
||||||
|
const allowedUnmanifested = new Set([
|
||||||
|
"mimetype",
|
||||||
|
"META-INF/container.xml",
|
||||||
|
"META-INF/encryption.xml",
|
||||||
|
"META-INF/signatures.xml",
|
||||||
|
book.package.packagePath,
|
||||||
|
]);
|
||||||
|
const hidden = book.entries.filter(
|
||||||
|
(entry) =>
|
||||||
|
!entry.directory &&
|
||||||
|
!manifestPaths.has(entry.filename) &&
|
||||||
|
!allowedUnmanifested.has(entry.filename),
|
||||||
|
);
|
||||||
|
if (hidden.length)
|
||||||
|
result.push(
|
||||||
|
issue(
|
||||||
|
"info",
|
||||||
|
"unmanifested-resources",
|
||||||
|
`${hidden.length} unmanifested archive entries are present. Review the package tree before sharing.`,
|
||||||
|
hidden[0]?.filename,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
import { decodeText } from "@add-ideas/toolbox-helpers";
|
||||||
|
|
||||||
|
export function decodeXml(bytes: Uint8Array): string {
|
||||||
|
if (bytes.length >= 2 && bytes[0] === 0xff && bytes[1] === 0xfe)
|
||||||
|
return decodeText(bytes.subarray(2), "utf-16le");
|
||||||
|
if (bytes.length >= 2 && bytes[0] === 0xfe && bytes[1] === 0xff)
|
||||||
|
return decodeText(bytes.subarray(2), "utf-16be");
|
||||||
|
const probe = new TextDecoder("ascii").decode(
|
||||||
|
bytes.subarray(0, Math.min(bytes.length, 256)),
|
||||||
|
);
|
||||||
|
const encoding = /<\?xml[^>]*encoding=["']([^"']+)/iu
|
||||||
|
.exec(probe)?.[1]
|
||||||
|
?.toLowerCase();
|
||||||
|
if (encoding && !["utf-8", "utf8"].includes(encoding))
|
||||||
|
throw new Error(
|
||||||
|
`Unsupported XML encoding: ${encoding}. EPUB text must use UTF-8 or UTF-16.`,
|
||||||
|
);
|
||||||
|
return decodeText(bytes, "utf-8");
|
||||||
|
}
|
||||||
|
|
||||||
|
export function parseXml(text: string, label: string): XMLDocument {
|
||||||
|
if (text.length > 16 * 1024 * 1024)
|
||||||
|
throw new RangeError(`${label} exceeds the 16 MiB XML limit.`);
|
||||||
|
if (/<!DOCTYPE|<!ENTITY/iu.test(text))
|
||||||
|
throw new Error(`${label} contains a forbidden DTD or entity declaration.`);
|
||||||
|
const document = new DOMParser().parseFromString(text, "application/xml");
|
||||||
|
const parserError = [...document.getElementsByTagName("parsererror")][0];
|
||||||
|
if (parserError)
|
||||||
|
throw new Error(
|
||||||
|
`${label} is not well-formed XML: ${parserError.textContent?.trim().slice(0, 240) ?? "parser error"}`,
|
||||||
|
);
|
||||||
|
return document;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function elementsByLocalName(
|
||||||
|
parent: ParentNode,
|
||||||
|
name: string,
|
||||||
|
): Element[] {
|
||||||
|
return [...parent.querySelectorAll("*")].filter(
|
||||||
|
(element) => element.localName === name,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function directChildrenByLocalName(
|
||||||
|
parent: Element,
|
||||||
|
name: string,
|
||||||
|
): Element[] {
|
||||||
|
return [...parent.children].filter((element) => element.localName === name);
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import { StrictMode } from "react";
|
||||||
|
import { createRoot } from "react-dom/client";
|
||||||
|
import { App } from "./App";
|
||||||
|
|
||||||
|
createRoot(document.getElementById("root")!).render(
|
||||||
|
<StrictMode>
|
||||||
|
<App />
|
||||||
|
</StrictMode>,
|
||||||
|
);
|
||||||
|
|
||||||
|
if ("serviceWorker" in navigator && import.meta.env.PROD) {
|
||||||
|
window.addEventListener("load", () => {
|
||||||
|
const url = new URL("./sw.js", document.baseURI);
|
||||||
|
void navigator.serviceWorker
|
||||||
|
.register(url, { scope: new URL("./", document.baseURI).pathname })
|
||||||
|
.catch(() => undefined);
|
||||||
|
});
|
||||||
|
}
|
||||||
+513
@@ -0,0 +1,513 @@
|
|||||||
|
:root {
|
||||||
|
--toolbox-background: #f6f7fb;
|
||||||
|
--toolbox-surface: #fff;
|
||||||
|
--toolbox-surface-soft: #eff1f7;
|
||||||
|
--toolbox-text: #202332;
|
||||||
|
--toolbox-muted: #656b7d;
|
||||||
|
--toolbox-border: #d9dce7;
|
||||||
|
--toolbox-accent: #5b4ec4;
|
||||||
|
--toolbox-accent-hover: #493caf;
|
||||||
|
--toolbox-accent-soft: #ece9ff;
|
||||||
|
--toolbox-accent-contrast: #fff;
|
||||||
|
--toolbox-focus: #137d75;
|
||||||
|
--toolbox-danger: #b42342;
|
||||||
|
}
|
||||||
|
* {
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
html {
|
||||||
|
min-width: 20rem;
|
||||||
|
min-height: 100%;
|
||||||
|
background: var(--toolbox-background);
|
||||||
|
scrollbar-gutter: stable;
|
||||||
|
}
|
||||||
|
body {
|
||||||
|
min-width: 20rem;
|
||||||
|
min-height: 100vh;
|
||||||
|
margin: 0;
|
||||||
|
background: var(--toolbox-background);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
font-family: Inter, ui-sans-serif, system-ui, sans-serif;
|
||||||
|
}
|
||||||
|
button,
|
||||||
|
input,
|
||||||
|
select,
|
||||||
|
textarea {
|
||||||
|
font: inherit;
|
||||||
|
}
|
||||||
|
button,
|
||||||
|
.button {
|
||||||
|
min-height: 2.55rem;
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
gap: 0.4rem;
|
||||||
|
padding: 0.55rem 0.8rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.65rem;
|
||||||
|
background: var(--toolbox-surface);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
font-weight: 720;
|
||||||
|
cursor: pointer;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
button:hover:not(:disabled),
|
||||||
|
.button:hover {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
button:disabled {
|
||||||
|
cursor: not-allowed;
|
||||||
|
opacity: 0.6;
|
||||||
|
}
|
||||||
|
:where(button, input, select, textarea, a):focus-visible {
|
||||||
|
outline: 3px solid color-mix(in srgb, var(--toolbox-focus) 42%, transparent);
|
||||||
|
outline-offset: 2px;
|
||||||
|
}
|
||||||
|
input,
|
||||||
|
select,
|
||||||
|
textarea {
|
||||||
|
width: 100%;
|
||||||
|
min-height: 2.55rem;
|
||||||
|
padding: 0.58rem 0.7rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.62rem;
|
||||||
|
background: var(--toolbox-surface);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
}
|
||||||
|
textarea {
|
||||||
|
min-height: 7rem;
|
||||||
|
resize: vertical;
|
||||||
|
line-height: 1.45;
|
||||||
|
}
|
||||||
|
input[type="file"] {
|
||||||
|
position: absolute;
|
||||||
|
width: 1px;
|
||||||
|
height: 1px;
|
||||||
|
min-height: 0;
|
||||||
|
padding: 0;
|
||||||
|
opacity: 0;
|
||||||
|
pointer-events: none;
|
||||||
|
}
|
||||||
|
.toolbox-shell__main {
|
||||||
|
width: min(100%, 90rem);
|
||||||
|
padding: clamp(0.75rem, 1.8vw, 1.5rem);
|
||||||
|
}
|
||||||
|
.workbench {
|
||||||
|
display: grid;
|
||||||
|
gap: 1rem;
|
||||||
|
}
|
||||||
|
.hero,
|
||||||
|
.panel,
|
||||||
|
.summary-grid article {
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.9rem;
|
||||||
|
background: var(--toolbox-surface);
|
||||||
|
box-shadow: 0 8px 28px rgb(30 36 70 / 4%);
|
||||||
|
}
|
||||||
|
.hero {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1rem;
|
||||||
|
align-items: flex-start;
|
||||||
|
padding: clamp(1.1rem, 3vw, 2rem);
|
||||||
|
}
|
||||||
|
.hero h1,
|
||||||
|
.panel h2,
|
||||||
|
.panel h3,
|
||||||
|
.help-dialog h2,
|
||||||
|
.fatal h1 {
|
||||||
|
margin: 0;
|
||||||
|
letter-spacing: -0.025em;
|
||||||
|
}
|
||||||
|
.hero p:not(.eyebrow) {
|
||||||
|
max-width: 57rem;
|
||||||
|
margin: 0.55rem 0 0;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
line-height: 1.55;
|
||||||
|
}
|
||||||
|
.eyebrow {
|
||||||
|
margin: 0 0 0.3rem;
|
||||||
|
color: var(--toolbox-accent);
|
||||||
|
font-size: 0.69rem;
|
||||||
|
font-weight: 820;
|
||||||
|
letter-spacing: 0.115em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
}
|
||||||
|
.privacy-pill {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
padding: 0.38rem 0.62rem;
|
||||||
|
border-radius: 999px;
|
||||||
|
background: var(--toolbox-accent-soft);
|
||||||
|
color: var(--toolbox-accent);
|
||||||
|
font-size: 0.75rem;
|
||||||
|
font-weight: 760;
|
||||||
|
}
|
||||||
|
.panel {
|
||||||
|
padding: 1rem;
|
||||||
|
}
|
||||||
|
.primary {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-accent);
|
||||||
|
color: var(--toolbox-accent-contrast);
|
||||||
|
}
|
||||||
|
.drop {
|
||||||
|
min-height: 19rem;
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: minmax(7rem, 13rem) minmax(15rem, 32rem);
|
||||||
|
place-content: center;
|
||||||
|
align-items: center;
|
||||||
|
gap: 2rem;
|
||||||
|
border-style: dashed;
|
||||||
|
}
|
||||||
|
.drop h2 {
|
||||||
|
margin-bottom: 0.6rem;
|
||||||
|
font-size: clamp(1.6rem, 4vw, 2.4rem);
|
||||||
|
}
|
||||||
|
.drop p:not(.eyebrow) {
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
line-height: 1.55;
|
||||||
|
}
|
||||||
|
.book-mark {
|
||||||
|
min-height: 11rem;
|
||||||
|
display: grid;
|
||||||
|
place-items: center;
|
||||||
|
border-radius: 0.8rem 0.4rem 0.4rem 0.8rem;
|
||||||
|
background: linear-gradient(140deg, var(--toolbox-accent), #8a75e8);
|
||||||
|
color: #fff;
|
||||||
|
font-size: 1.4rem;
|
||||||
|
font-weight: 900;
|
||||||
|
letter-spacing: 0.15em;
|
||||||
|
box-shadow: inset 1rem 0 rgb(0 0 0 / 12%);
|
||||||
|
}
|
||||||
|
.file-bar {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1rem;
|
||||||
|
align-items: center;
|
||||||
|
}
|
||||||
|
.file-bar > div {
|
||||||
|
min-width: 0;
|
||||||
|
display: grid;
|
||||||
|
gap: 0.2rem;
|
||||||
|
}
|
||||||
|
.file-bar strong {
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
.file-bar span {
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
}
|
||||||
|
.summary-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(4, 1fr);
|
||||||
|
gap: 0.75rem;
|
||||||
|
}
|
||||||
|
.summary-grid article {
|
||||||
|
min-width: 0;
|
||||||
|
display: grid;
|
||||||
|
gap: 0.35rem;
|
||||||
|
padding: 0.85rem;
|
||||||
|
}
|
||||||
|
.summary-grid span {
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.72rem;
|
||||||
|
font-weight: 760;
|
||||||
|
text-transform: uppercase;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
}
|
||||||
|
.summary-grid strong,
|
||||||
|
.summary-grid small {
|
||||||
|
overflow: hidden;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
}
|
||||||
|
.summary-grid small {
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
}
|
||||||
|
.summary-grid .good {
|
||||||
|
border-color: #55a875;
|
||||||
|
}
|
||||||
|
.summary-grid .warn {
|
||||||
|
border-color: #d9a72e;
|
||||||
|
}
|
||||||
|
.summary-grid .bad {
|
||||||
|
border-color: var(--toolbox-danger);
|
||||||
|
}
|
||||||
|
.workspace-tabs {
|
||||||
|
display: flex;
|
||||||
|
gap: 0.4rem;
|
||||||
|
overflow-x: auto;
|
||||||
|
padding: 0.75rem;
|
||||||
|
}
|
||||||
|
.workspace-tabs button[aria-selected="true"] {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-accent);
|
||||||
|
color: var(--toolbox-accent-contrast);
|
||||||
|
}
|
||||||
|
.workspace {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.9rem;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
.panel-heading {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1rem;
|
||||||
|
align-items: end;
|
||||||
|
margin-bottom: 0.9rem;
|
||||||
|
}
|
||||||
|
.reader-layout {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: minmax(15rem, 19rem) minmax(0, 1fr);
|
||||||
|
gap: 1rem;
|
||||||
|
align-items: start;
|
||||||
|
}
|
||||||
|
.chapter-list {
|
||||||
|
max-height: calc(100vh - 12rem);
|
||||||
|
display: grid;
|
||||||
|
gap: 0.35rem;
|
||||||
|
overflow: auto;
|
||||||
|
position: sticky;
|
||||||
|
top: 0.75rem;
|
||||||
|
}
|
||||||
|
.chapter-list > div {
|
||||||
|
margin-bottom: 0.4rem;
|
||||||
|
}
|
||||||
|
.chapter-list button {
|
||||||
|
justify-content: start;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
.chapter-list button > span {
|
||||||
|
flex: 0 0 1.8rem;
|
||||||
|
display: grid;
|
||||||
|
place-items: center;
|
||||||
|
min-height: 1.8rem;
|
||||||
|
border-radius: 999px;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.7rem;
|
||||||
|
}
|
||||||
|
.chapter-list button.active {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-accent-soft);
|
||||||
|
color: var(--toolbox-accent);
|
||||||
|
}
|
||||||
|
.page-reader {
|
||||||
|
min-height: 38rem;
|
||||||
|
min-width: 0;
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
.page-reader iframe {
|
||||||
|
width: 100%;
|
||||||
|
height: min(65rem, calc(100vh - 13rem));
|
||||||
|
min-height: 34rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.65rem;
|
||||||
|
background: #fff;
|
||||||
|
}
|
||||||
|
.field {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.35rem;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
.field > span {
|
||||||
|
font-size: 0.76rem;
|
||||||
|
font-weight: 750;
|
||||||
|
}
|
||||||
|
.form-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(auto-fit, minmax(min(100%, 14rem), 1fr));
|
||||||
|
gap: 0.7rem;
|
||||||
|
}
|
||||||
|
.issue-group {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.5rem;
|
||||||
|
}
|
||||||
|
.issue {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: minmax(9rem, 0.35fr) 1fr;
|
||||||
|
gap: 0.6rem;
|
||||||
|
padding: 0.65rem;
|
||||||
|
border-left: 0.25rem solid var(--toolbox-border);
|
||||||
|
border-radius: 0.45rem;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
.issue.error {
|
||||||
|
border-color: var(--toolbox-danger);
|
||||||
|
}
|
||||||
|
.issue.warning {
|
||||||
|
border-color: #d9a72e;
|
||||||
|
}
|
||||||
|
.issue.info {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
}
|
||||||
|
.issue code {
|
||||||
|
grid-column: 2;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
}
|
||||||
|
.table-scroll {
|
||||||
|
max-height: 42rem;
|
||||||
|
overflow: auto;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.65rem;
|
||||||
|
}
|
||||||
|
table {
|
||||||
|
width: 100%;
|
||||||
|
border-collapse: collapse;
|
||||||
|
font-size: 0.82rem;
|
||||||
|
}
|
||||||
|
th,
|
||||||
|
td {
|
||||||
|
padding: 0.55rem;
|
||||||
|
border-bottom: 1px solid var(--toolbox-border);
|
||||||
|
text-align: left;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
th {
|
||||||
|
position: sticky;
|
||||||
|
top: 0;
|
||||||
|
z-index: 1;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
td code {
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
}
|
||||||
|
.export-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: 1fr 1fr;
|
||||||
|
gap: 0.8rem;
|
||||||
|
}
|
||||||
|
.export-grid article {
|
||||||
|
display: grid;
|
||||||
|
align-content: start;
|
||||||
|
gap: 0.7rem;
|
||||||
|
padding: 0.85rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.7rem;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
.export-grid p {
|
||||||
|
margin: 0;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
.actions {
|
||||||
|
display: flex;
|
||||||
|
gap: 0.5rem;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
}
|
||||||
|
.check {
|
||||||
|
display: flex;
|
||||||
|
gap: 0.5rem;
|
||||||
|
align-items: center;
|
||||||
|
font-weight: 680;
|
||||||
|
}
|
||||||
|
.check input {
|
||||||
|
width: auto;
|
||||||
|
min-height: auto;
|
||||||
|
}
|
||||||
|
.muted {
|
||||||
|
margin: 0;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
.empty {
|
||||||
|
min-height: 10rem;
|
||||||
|
display: grid;
|
||||||
|
place-items: center;
|
||||||
|
margin: 0;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.error,
|
||||||
|
.warning,
|
||||||
|
.notice,
|
||||||
|
.success {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0.7rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.65rem;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
.error {
|
||||||
|
border-color: var(--toolbox-danger);
|
||||||
|
color: var(--toolbox-danger);
|
||||||
|
}
|
||||||
|
.warning {
|
||||||
|
border-color: #d9a72e;
|
||||||
|
background: #fff8df;
|
||||||
|
color: #725000;
|
||||||
|
}
|
||||||
|
.notice {
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
.success {
|
||||||
|
border-color: #55a875;
|
||||||
|
background: #eaf8ef;
|
||||||
|
color: #176137;
|
||||||
|
}
|
||||||
|
.loading,
|
||||||
|
.fatal {
|
||||||
|
width: min(100% - 2rem, 60rem);
|
||||||
|
margin: 2rem auto;
|
||||||
|
padding: 1rem;
|
||||||
|
}
|
||||||
|
.help-dialog {
|
||||||
|
width: min(36rem, calc(100% - 2rem));
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.9rem;
|
||||||
|
background: var(--toolbox-surface);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
}
|
||||||
|
.help-dialog::backdrop {
|
||||||
|
background: rgb(20 24 45 / 55%);
|
||||||
|
}
|
||||||
|
.dialog-heading {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1rem;
|
||||||
|
align-items: start;
|
||||||
|
}
|
||||||
|
@media (max-width: 68rem) {
|
||||||
|
.summary-grid {
|
||||||
|
grid-template-columns: repeat(2, 1fr);
|
||||||
|
}
|
||||||
|
.reader-layout {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
.chapter-list {
|
||||||
|
position: static;
|
||||||
|
max-height: 18rem;
|
||||||
|
}
|
||||||
|
.export-grid {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media (max-width: 44rem) {
|
||||||
|
.hero,
|
||||||
|
.file-bar,
|
||||||
|
.panel-heading {
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: stretch;
|
||||||
|
}
|
||||||
|
.privacy-pill {
|
||||||
|
order: -1;
|
||||||
|
align-self: start;
|
||||||
|
}
|
||||||
|
.drop {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
.book-mark {
|
||||||
|
min-height: 6rem;
|
||||||
|
}
|
||||||
|
.summary-grid {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
.issue {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
.issue code {
|
||||||
|
grid-column: auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
import "@testing-library/jest-dom/vitest";
|
||||||
|
import { afterEach } from "vitest";
|
||||||
|
import { cleanup } from "@testing-library/react";
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
cleanup();
|
||||||
|
localStorage.clear();
|
||||||
|
});
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://git.add-ideas.de/lotobo/toolbox-sdk/raw/branch/main/schemas/toolbox-app.v1.schema.json",
|
||||||
|
"schemaVersion": 1,
|
||||||
|
"id": "de.add-ideas.epub-tools",
|
||||||
|
"name": "EPUB Tools",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Read, inspect and repair EPUB publications locally in the browser.",
|
||||||
|
"entry": "./",
|
||||||
|
"icon": "./favicon.svg",
|
||||||
|
"categories": ["documents", "ebooks", "publishing"],
|
||||||
|
"tags": ["epub", "ebook", "metadata", "reader", "repair"],
|
||||||
|
"integration": {
|
||||||
|
"contextVersion": 1,
|
||||||
|
"launchModes": ["navigate", "new-tab"],
|
||||||
|
"embedding": "unsupported"
|
||||||
|
},
|
||||||
|
"requirements": {
|
||||||
|
"secureContext": false,
|
||||||
|
"workers": true,
|
||||||
|
"indexedDb": false,
|
||||||
|
"crossOriginIsolated": false,
|
||||||
|
"topLevelContext": false
|
||||||
|
},
|
||||||
|
"privacy": {
|
||||||
|
"processing": "local",
|
||||||
|
"fileUploads": true,
|
||||||
|
"telemetry": false,
|
||||||
|
"label": "Inputs stay in this browser; nothing is uploaded."
|
||||||
|
},
|
||||||
|
"source": {
|
||||||
|
"repository": "https://git.add-ideas.de/lotobo/epub-tools",
|
||||||
|
"license": "GPL-3.0-or-later"
|
||||||
|
},
|
||||||
|
"actions": [
|
||||||
|
{
|
||||||
|
"id": "source",
|
||||||
|
"label": "Source",
|
||||||
|
"url": "https://git.add-ideas.de/lotobo/epub-tools"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
import { defineToolboxApp, parseToolboxApp } from "@add-ideas/toolbox-contract";
|
||||||
|
import source from "./manifest.source.json";
|
||||||
|
|
||||||
|
export const manifest = defineToolboxApp(parseToolboxApp(source));
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
export const APP_VERSION = "0.1.0";
|
||||||
Vendored
+1
@@ -0,0 +1 @@
|
|||||||
|
/// <reference types="vite/client" />
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
import { expect, test, type Page } from "@playwright/test";
|
||||||
|
import {
|
||||||
|
TextReader,
|
||||||
|
Uint8ArrayReader,
|
||||||
|
Uint8ArrayWriter,
|
||||||
|
ZipWriter,
|
||||||
|
} from "@zip.js/zip.js";
|
||||||
|
|
||||||
|
const ORIGIN = "http://127.0.0.1:4173";
|
||||||
|
async function localOnly(page: Page) {
|
||||||
|
const external: string[] = [];
|
||||||
|
await page.route("**/*", async (route) => {
|
||||||
|
const url = new URL(route.request().url());
|
||||||
|
if (url.origin !== ORIGIN) {
|
||||||
|
external.push(url.href);
|
||||||
|
await route.abort();
|
||||||
|
} else await route.continue();
|
||||||
|
});
|
||||||
|
return external;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function epubFixture(): Promise<Buffer> {
|
||||||
|
const writer = new ZipWriter(new Uint8ArrayWriter());
|
||||||
|
await writer.add("mimetype", new TextReader("application/epub+zip"), {
|
||||||
|
level: 0,
|
||||||
|
});
|
||||||
|
await writer.add(
|
||||||
|
"META-INF/container.xml",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0"?><container xmlns="urn:oasis:names:tc:opendocument:xmlns:container"><rootfiles><rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/></rootfiles></container>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/package.opf",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0"?><package xmlns="http://www.idpf.org/2007/opf" version="3.0" unique-identifier="id"><metadata xmlns:dc="http://purl.org/dc/elements/1.1/"><dc:identifier id="id">urn:browser:test</dc:identifier><dc:title>Browser Fixture</dc:title><dc:language>en</dc:language><dc:creator>Local Author</dc:creator></metadata><manifest><item id="nav" href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/><item id="chapter" href="chapter.xhtml" media-type="application/xhtml+xml"/><item id="cover" href="cover.png" media-type="image/png" properties="cover-image"/></manifest><spine><itemref idref="chapter"/></spine></package>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/nav.xhtml",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops"><body><nav epub:type="toc"><ol><li><a href="chapter.xhtml">A safe chapter</a></li></ol></nav></body></html>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/chapter.xhtml",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0"?><html xmlns="http://www.w3.org/1999/xhtml"><head><title>A safe chapter</title></head><body><h1>Hello from EPUB</h1><script>document.body.textContent='unsafe'</script><img src="cover.png"/></body></html>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/cover.png",
|
||||||
|
new Uint8ArrayReader(
|
||||||
|
Buffer.from(
|
||||||
|
"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=",
|
||||||
|
"base64",
|
||||||
|
),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
return Buffer.from(await writer.close());
|
||||||
|
}
|
||||||
|
|
||||||
|
test("runs from a nested path without external requests", async ({ page }) => {
|
||||||
|
const errors: string[] = [];
|
||||||
|
page.on("pageerror", (error) => errors.push(error.message));
|
||||||
|
page.on("console", (message) => {
|
||||||
|
if (message.type() === "error") errors.push(message.text());
|
||||||
|
});
|
||||||
|
const external = await localOnly(page);
|
||||||
|
await page.goto("/deep/nested/epub/");
|
||||||
|
await expect(page.getByRole("heading", { name: "EPUB Tools" })).toBeVisible();
|
||||||
|
expect(external).toEqual([]);
|
||||||
|
expect(errors).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("serves the release identity and hardened headers", async ({
|
||||||
|
request,
|
||||||
|
}) => {
|
||||||
|
const index = await request.get("/deep/nested/epub/");
|
||||||
|
expect(index.ok()).toBe(true);
|
||||||
|
expect(index.headers()["content-security-policy"]).toContain(
|
||||||
|
"default-src 'self'",
|
||||||
|
);
|
||||||
|
expect(await index.text()).not.toMatch(/\b(?:src|href)=["']\//u);
|
||||||
|
const manifest = await request.get("/deep/nested/epub/toolbox-app.json");
|
||||||
|
await expect(manifest.json()).resolves.toMatchObject({
|
||||||
|
id: "de.add-ideas.epub-tools",
|
||||||
|
version: "0.1.0",
|
||||||
|
entry: "./",
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("opens, sanitizes, edits, rebuilds, and reopens a real EPUB", async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
const external = await localOnly(page);
|
||||||
|
await page.goto("/deep/nested/epub/");
|
||||||
|
await page.getByLabel("Choose EPUB").setInputFiles({
|
||||||
|
name: "fixture.epub",
|
||||||
|
mimeType: "application/epub+zip",
|
||||||
|
buffer: await epubFixture(),
|
||||||
|
});
|
||||||
|
await expect(
|
||||||
|
page.getByText("Browser Fixture", { exact: true }).first(),
|
||||||
|
).toBeVisible({ timeout: 30_000 });
|
||||||
|
const reader = page.frameLocator("iframe[title^='Safe EPUB preview']");
|
||||||
|
await expect(
|
||||||
|
reader.getByRole("heading", { name: "Hello from EPUB" }),
|
||||||
|
).toBeVisible();
|
||||||
|
await expect(reader.locator("script")).toHaveCount(0);
|
||||||
|
await page.getByRole("tab", { name: "Metadata" }).click();
|
||||||
|
await page.getByLabel("Title").fill("Updated in browser");
|
||||||
|
await page.getByRole("tab", { name: "Export & rebuild" }).click();
|
||||||
|
const downloadPromise = page.waitForEvent("download");
|
||||||
|
await page.getByRole("button", { name: "Create updated EPUB" }).click();
|
||||||
|
const download = await downloadPromise;
|
||||||
|
const path = await download.path();
|
||||||
|
expect(path).toBeTruthy();
|
||||||
|
await page.getByLabel("Open another").setInputFiles(path!);
|
||||||
|
await expect(
|
||||||
|
page.getByText("Updated in browser", { exact: true }).first(),
|
||||||
|
).toBeVisible({ timeout: 30_000 });
|
||||||
|
expect(external).toEqual([]);
|
||||||
|
});
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
import { render, screen } from "@testing-library/react";
|
||||||
|
import { describe, expect, it, vi } from "vitest";
|
||||||
|
import { App } from "../../src/App";
|
||||||
|
|
||||||
|
describe("EPUB Tools", () => {
|
||||||
|
it("renders the local workbench and standard shell", async () => {
|
||||||
|
vi.stubGlobal(
|
||||||
|
"fetch",
|
||||||
|
vi.fn(async () => new Response("Not found", { status: 404 })),
|
||||||
|
);
|
||||||
|
render(<App />);
|
||||||
|
expect(
|
||||||
|
await screen.findByRole("heading", { name: "EPUB Tools" }),
|
||||||
|
).toBeVisible();
|
||||||
|
expect(
|
||||||
|
await screen.findByText("Sandboxed reader · local files"),
|
||||||
|
).toBeVisible();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,114 @@
|
|||||||
|
import { Blob as NodeBlob, File as NodeFile } from "node:buffer";
|
||||||
|
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||||
|
import { closeBook, openEpub } from "../../src/epub/archive";
|
||||||
|
import { patchPackageMetadata, rebuildEpub } from "../../src/epub/export";
|
||||||
|
import { resolvePackageHref, validateEntryPath } from "../../src/epub/paths";
|
||||||
|
import { renderChapter, revokeRenderedChapter } from "../../src/epub/reader";
|
||||||
|
import type { EpubBook } from "../../src/epub/types";
|
||||||
|
import { createEpubFixture } from "./fixture";
|
||||||
|
|
||||||
|
let opened: EpubBook[] = [];
|
||||||
|
beforeEach(() => {
|
||||||
|
vi.stubGlobal("Blob", NodeBlob);
|
||||||
|
vi.stubGlobal("File", NodeFile);
|
||||||
|
});
|
||||||
|
afterEach(async () => {
|
||||||
|
for (const book of opened) await closeBook(book);
|
||||||
|
opened = [];
|
||||||
|
vi.unstubAllGlobals();
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("EPUB path policy", () => {
|
||||||
|
it("resolves package-relative references and rejects traversal", () => {
|
||||||
|
expect(
|
||||||
|
resolvePackageHref("EPUB/text/chapter.xhtml", "../images/cover.png#art"),
|
||||||
|
).toBe("EPUB/images/cover.png");
|
||||||
|
expect(() => resolvePackageHref("chapter.xhtml", "../outside")).toThrow(
|
||||||
|
/escapes/u,
|
||||||
|
);
|
||||||
|
expect(() => validateEntryPath("../escape")).toThrow(/traversal/u);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("EPUB package inspection", () => {
|
||||||
|
it("opens metadata, navigation, spine, and bounded inventory", async () => {
|
||||||
|
const book = await openEpub(await createEpubFixture());
|
||||||
|
opened.push(book);
|
||||||
|
expect(book.package.metadata).toMatchObject({
|
||||||
|
title: "Fixture Book",
|
||||||
|
language: "en",
|
||||||
|
identifier: "urn:test:book",
|
||||||
|
});
|
||||||
|
expect(book.package.navigation[0]).toMatchObject({
|
||||||
|
label: "Opening chapter",
|
||||||
|
path: "EPUB/chapter.xhtml",
|
||||||
|
});
|
||||||
|
expect(book.package.spine[0]?.item?.path).toBe("EPUB/chapter.xhtml");
|
||||||
|
expect(book.summary).toMatchObject({
|
||||||
|
mimetypeFirst: true,
|
||||||
|
mimetypeStored: true,
|
||||||
|
encryptedResources: false,
|
||||||
|
});
|
||||||
|
expect(book.issues.filter((item) => item.severity === "error")).toEqual([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("reports active content and broken resources", async () => {
|
||||||
|
const book = await openEpub(
|
||||||
|
await createEpubFixture({ activeContent: true, brokenLink: true }),
|
||||||
|
);
|
||||||
|
opened.push(book);
|
||||||
|
expect(book.issues.map((item) => item.code)).toEqual(
|
||||||
|
expect.arrayContaining(["active-content", "broken-link"]),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("safe rendering and editing", () => {
|
||||||
|
it("removes active content, disables links, and resolves local images", async () => {
|
||||||
|
vi.stubGlobal("URL", {
|
||||||
|
...URL,
|
||||||
|
createObjectURL: vi.fn(() => "blob:fixture-cover"),
|
||||||
|
revokeObjectURL: vi.fn(),
|
||||||
|
});
|
||||||
|
const book = await openEpub(
|
||||||
|
await createEpubFixture({ activeContent: true }),
|
||||||
|
);
|
||||||
|
opened.push(book);
|
||||||
|
const chapter = await renderChapter(book, "EPUB/chapter.xhtml");
|
||||||
|
expect(chapter.html).not.toMatch(/<script|<form|<input/iu);
|
||||||
|
expect(chapter.html).toContain('src="blob:fixture-cover"');
|
||||||
|
expect(chapter.html).toContain('data-epub-href="nav.xhtml"');
|
||||||
|
expect(chapter.html).toContain("default-src 'none'");
|
||||||
|
revokeRenderedChapter(chapter);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("patches metadata and rebuilds a readable normalized EPUB", async () => {
|
||||||
|
const book = await openEpub(await createEpubFixture());
|
||||||
|
opened.push(book);
|
||||||
|
const metadata = {
|
||||||
|
...book.package.metadata,
|
||||||
|
title: "Updated title",
|
||||||
|
creators: ["One", "Two"],
|
||||||
|
subjects: ["Testing"],
|
||||||
|
};
|
||||||
|
const xml = patchPackageMetadata(book.packageXml, metadata);
|
||||||
|
expect(xml).toContain("Updated title");
|
||||||
|
expect(xml.match(/<dc:creator/gu)).toHaveLength(2);
|
||||||
|
const rebuilt = await rebuildEpub(book, {
|
||||||
|
metadata,
|
||||||
|
normalizeTimestamps: true,
|
||||||
|
});
|
||||||
|
const reopened = await openEpub(
|
||||||
|
new File([rebuilt.blob], "rebuilt.epub", {
|
||||||
|
type: "application/epub+zip",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
opened.push(reopened);
|
||||||
|
expect(reopened.package.metadata.title).toBe("Updated title");
|
||||||
|
expect(reopened.package.metadata.creators).toEqual(["One", "Two"]);
|
||||||
|
expect(reopened.summary).toMatchObject({
|
||||||
|
mimetypeFirst: true,
|
||||||
|
mimetypeStored: true,
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
import {
|
||||||
|
BlobWriter,
|
||||||
|
TextReader,
|
||||||
|
Uint8ArrayReader,
|
||||||
|
ZipWriter,
|
||||||
|
} from "@zip.js/zip.js";
|
||||||
|
|
||||||
|
export async function createEpubFixture(
|
||||||
|
options: {
|
||||||
|
brokenLink?: boolean;
|
||||||
|
activeContent?: boolean;
|
||||||
|
compressedMimetype?: boolean;
|
||||||
|
} = {},
|
||||||
|
): Promise<File> {
|
||||||
|
const writer = new ZipWriter(new BlobWriter("application/epub+zip"));
|
||||||
|
await writer.add("mimetype", new TextReader("application/epub+zip"), {
|
||||||
|
level: options.compressedMimetype ? 6 : 0,
|
||||||
|
});
|
||||||
|
await writer.add(
|
||||||
|
"META-INF/container.xml",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0"?><container xmlns="urn:oasis:names:tc:opendocument:xmlns:container"><rootfiles><rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/></rootfiles></container>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/package.opf",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0" encoding="UTF-8"?><package xmlns="http://www.idpf.org/2007/opf" version="3.0" unique-identifier="book-id"><metadata xmlns:dc="http://purl.org/dc/elements/1.1/"><dc:identifier id="book-id">urn:test:book</dc:identifier><dc:title>Fixture Book</dc:title><dc:language>en</dc:language><dc:creator>Ada Example</dc:creator></metadata><manifest><item id="nav" href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/><item id="chapter" href="chapter.xhtml" media-type="application/xhtml+xml"/><item id="cover" href="cover.png" media-type="image/png" properties="cover-image"/></manifest><spine><itemref idref="chapter"/></spine></package>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/nav.xhtml",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops"><head><title>Contents</title></head><body><nav epub:type="toc"><ol><li><a href="chapter.xhtml">Opening chapter</a></li></ol></nav></body></html>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/chapter.xhtml",
|
||||||
|
new TextReader(
|
||||||
|
`<?xml version="1.0"?><html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opening chapter</title></head><body><h1>Hello</h1><p>Local reading.</p>${options.activeContent ? "<script>globalThis.pwned=true</script><form><input/></form>" : ""}<img src="cover.png"/><a href="${options.brokenLink ? "missing.xhtml" : "nav.xhtml"}">Next</a></body></html>`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await writer.add(
|
||||||
|
"EPUB/cover.png",
|
||||||
|
new Uint8ArrayReader(
|
||||||
|
new Uint8Array([0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a]),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
const blob = await writer.close();
|
||||||
|
return new File([blob], "fixture.epub", { type: "application/epub+zip" });
|
||||||
|
}
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
|
||||||
|
"target": "ES2023",
|
||||||
|
"lib": ["ES2023", "DOM", "DOM.Iterable"],
|
||||||
|
"module": "ESNext",
|
||||||
|
"types": ["vite/client", "node"],
|
||||||
|
"allowArbitraryExtensions": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"moduleResolution": "Bundler",
|
||||||
|
"allowImportingTsExtensions": true,
|
||||||
|
"verbatimModuleSyntax": true,
|
||||||
|
"moduleDetection": "force",
|
||||||
|
"noEmit": true,
|
||||||
|
"jsx": "react-jsx",
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true,
|
||||||
|
"erasableSyntaxOnly": true,
|
||||||
|
"noFallthroughCasesInSwitch": true,
|
||||||
|
"strict": true,
|
||||||
|
"noUncheckedIndexedAccess": true,
|
||||||
|
"useDefineForClassFields": true,
|
||||||
|
"resolveJsonModule": true,
|
||||||
|
"isolatedModules": true
|
||||||
|
},
|
||||||
|
"include": ["src", "tests"]
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"files": [],
|
||||||
|
"references": [
|
||||||
|
{
|
||||||
|
"path": "./tsconfig.app.json"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./tsconfig.node.json"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
|
||||||
|
"target": "ES2023",
|
||||||
|
"lib": ["ES2023"],
|
||||||
|
"module": "ESNext",
|
||||||
|
"types": ["node"],
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"moduleResolution": "Bundler",
|
||||||
|
"allowImportingTsExtensions": true,
|
||||||
|
"verbatimModuleSyntax": true,
|
||||||
|
"moduleDetection": "force",
|
||||||
|
"noEmit": true,
|
||||||
|
"strict": true,
|
||||||
|
"noUnusedLocals": true,
|
||||||
|
"noUnusedParameters": true
|
||||||
|
},
|
||||||
|
"include": [
|
||||||
|
"vite.config.ts",
|
||||||
|
"playwright.config.ts",
|
||||||
|
"eslint.config.mjs",
|
||||||
|
"scripts/**/*.mjs"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
/// <reference types="vitest/config" />
|
||||||
|
import { defineConfig } from "vite";
|
||||||
|
import react from "@vitejs/plugin-react";
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
base: "./",
|
||||||
|
plugins: [react()],
|
||||||
|
test: {
|
||||||
|
environment: "jsdom",
|
||||||
|
setupFiles: "./src/test/setup.ts",
|
||||||
|
css: true,
|
||||||
|
maxWorkers: 2,
|
||||||
|
restoreMocks: true,
|
||||||
|
exclude: ["tests/browser/**", "node_modules/**", "dist/**"],
|
||||||
|
},
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user