Release API 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,9 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 0.1.0 - 2026-09-01
|
||||||
|
|
||||||
|
- Initial local-only OpenAPI 3.0/3.1 inspection release.
|
||||||
|
- Added bounded JSON/YAML parsing and explicit local multi-file references.
|
||||||
|
- Added operation navigation, security inventory, schema and exchange examples.
|
||||||
|
- Added inert curl, Fetch and Python request text and conservative comparisons.
|
||||||
|
- Added HAR/raw-exchange inventory, offline PWA and deterministic release ZIP.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
Keep parsing bounded, output inert, and network execution absent. Parser or
|
||||||
|
reference changes need malformed, traversal, alias, cycle and limit tests.
|
||||||
|
Generation must disclose loss or heuristics. Run `npm run check` and both
|
||||||
|
Playwright projects, and update the changelog/security 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,4 @@
|
|||||||
|
# Licence materials
|
||||||
|
|
||||||
|
`../LICENSE` contains GPL-3.0-or-later terms. Release builds add an exact
|
||||||
|
`npm-runtime-licenses.txt` generated from locked runtime packages.
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
# API Tools
|
||||||
|
|
||||||
|
API Tools is a local-first OpenAPI workbench. Version 0.1.0 parses bounded JSON
|
||||||
|
or YAML OpenAPI 3.0/3.1 descriptions, navigates operations, resolves `$ref`
|
||||||
|
values from explicitly supplied local files, inventories security schemes,
|
||||||
|
generates schema/request/response examples and inert client command text,
|
||||||
|
compares revisions, and summarizes saved HTTP exchanges or HAR 1.2 files.
|
||||||
|
|
||||||
|
It never executes HTTP, follows a URL, resolves a remote reference, stores a
|
||||||
|
credential or loads an external asset. Generated curl, Fetch and Python snippets
|
||||||
|
are text for review and may reproduce untrusted description values safely
|
||||||
|
quoted for their target syntax.
|
||||||
|
|
||||||
|
## Development and release
|
||||||
|
|
||||||
|
Requires Node.js 22+ and npm 11+.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm ci
|
||||||
|
npm run check
|
||||||
|
npm run test:browser
|
||||||
|
npm run release:artifact
|
||||||
|
```
|
||||||
|
|
||||||
|
The release command writes deterministic `release/api-tools-0.1.0.zip` and a
|
||||||
|
SHA-256 sidecar. Relative assets are tested at `/deep/nested/api/`.
|
||||||
|
|
||||||
|
## v0.1 boundary
|
||||||
|
|
||||||
|
- JSON/YAML files up to 4 MiB each, 20 files/16 MiB per selected workspace,
|
||||||
|
depth 64, 100,000 values, 50 YAML aliases, 2,000 operations;
|
||||||
|
- focused OpenAPI identity/info/paths checks and remote-reference rejection;
|
||||||
|
- fragment/relative-file JSON Pointer resolution with missing/cycle reports;
|
||||||
|
- bounded sample generation for common schema composition and scalar formats;
|
||||||
|
- path/query/request/response examples and inert curl/Fetch/Python output;
|
||||||
|
- security scheme inventory, conservative operation compatibility report;
|
||||||
|
- HAR or raw saved-exchange summary without rendering bodies or secrets.
|
||||||
|
|
||||||
|
This is not a complete OpenAPI/JSON Schema validator, code generator, API
|
||||||
|
client, proxy or security scanner. See the documented limitations and review
|
||||||
|
generated values before use. Licensed under GPL-3.0-or-later.
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
Report vulnerabilities privately through the repository security contact.
|
||||||
|
Never paste real credentials or private HAR content into a public issue.
|
||||||
|
|
||||||
|
Descriptions, examples, URLs and exchanges are hostile inert data. API Tools
|
||||||
|
must not execute generated text or resolve external references. Deploy with the
|
||||||
|
same-origin CSP. Security fixes target the current release.
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Corresponding source
|
||||||
|
|
||||||
|
The corresponding source for API Tools 0.1.0 is available at:
|
||||||
|
|
||||||
|
https://git.add-ideas.de/lotobo/api-tools/src/tag/v0.1.0
|
||||||
|
|
||||||
|
Build with Node.js 22+, npm 11+, and `package-lock.json` by running
|
||||||
|
`npm ci && npm run release:artifact`.
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Third-party notices
|
||||||
|
|
||||||
|
API Tools is GPL-3.0-or-later. Runtime components include React and React DOM
|
||||||
|
(MIT), YAML (ISC), and the add·ideas Toolbox contract, shell and helpers (their
|
||||||
|
package metadata and corresponding source apply).
|
||||||
|
|
||||||
|
The release build generates an exact runtime notice bundle at
|
||||||
|
`LICENSES/npm-runtime-licenses.txt`. No remote assets or services are used.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Accessibility
|
||||||
|
|
||||||
|
The app uses native labels, buttons, headings, lists, tables and status/alert
|
||||||
|
regions. Operation selection and all workspaces are keyboard accessible. Focus
|
||||||
|
styles and light/dark/system themes come from the shared shell. Tables and code
|
||||||
|
panes scroll, responsive layouts collapse to one column, and reduced motion is
|
||||||
|
honoured.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Architecture
|
||||||
|
|
||||||
|
The shell lazy-loads a React workbench. Pure core modules parse and validate
|
||||||
|
JSON-like values, hold a named in-memory document map, resolve only relative
|
||||||
|
local references, collect operations, derive bounded examples, compare
|
||||||
|
operation contracts and summarize saved exchanges. No module exposes a request
|
||||||
|
executor.
|
||||||
|
|
||||||
|
JSON uses hardened shared helpers. YAML is converted with bounded alias count
|
||||||
|
and then recursively checked for depth, node count, dangerous keys and plain
|
||||||
|
JSON values. Rendering uses React text nodes and read-only textareas. The
|
||||||
|
same-origin service worker caches only packaged application resources.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Privacy and security
|
||||||
|
|
||||||
|
Descriptions and exchanges remain in memory and are never transmitted or
|
||||||
|
persisted. All remote/absolute `$ref` forms fail closed. Displayed URLs are text,
|
||||||
|
not links. There is no Try It button, OAuth flow, DNS lookup, HTTP execution,
|
||||||
|
telemetry or external asset.
|
||||||
|
|
||||||
|
HAR and saved exchanges commonly contain tokens, cookies, personal data and
|
||||||
|
payloads. The summary does not render header values, yet the source editor still
|
||||||
|
contains them. Clear it before sharing. Generated examples are heuristic and
|
||||||
|
must not be treated as valid production data. Validation and compatibility
|
||||||
|
checks cover a useful subset, not every OpenAPI or JSON Schema rule.
|
||||||
@@ -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="Inspect and compare OpenAPI descriptions 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>API Tools</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div id="root"></div>
|
||||||
|
<script type="module" src="./src/main.tsx"></script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
Generated
+3995
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,72 @@
|
|||||||
|
{
|
||||||
|
"name": "api-tools",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Inspect, compare and derive examples from OpenAPI descriptions locally in the browser.",
|
||||||
|
"license": "GPL-3.0-or-later",
|
||||||
|
"author": "Albrecht Degering",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://git.add-ideas.de/lotobo/api-tools.git"
|
||||||
|
},
|
||||||
|
"homepage": "https://git.add-ideas.de/lotobo/api-tools",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://git.add-ideas.de/lotobo/api-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",
|
||||||
|
"react": "19.2.8",
|
||||||
|
"react-dom": "19.2.8",
|
||||||
|
"yaml": "2.9.0"
|
||||||
|
},
|
||||||
|
"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:4196", trace: "retain-on-failure" },
|
||||||
|
webServer: {
|
||||||
|
command: "npm run build && node scripts/serve-test.mjs",
|
||||||
|
url: "http://127.0.0.1:4196",
|
||||||
|
reuseExistingServer: !process.env.CI,
|
||||||
|
timeout: 180_000,
|
||||||
|
},
|
||||||
|
projects: [
|
||||||
|
{ name: "chromium", use: { ...devices["Desktop Chrome"] } },
|
||||||
|
{ name: "firefox", use: { ...devices["Desktop Firefox"] } },
|
||||||
|
],
|
||||||
|
});
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
## 0.1.0 - 2026-09-01
|
||||||
|
|
||||||
|
- Initial local-only OpenAPI 3.0/3.1 inspection release.
|
||||||
|
- Added bounded JSON/YAML parsing and explicit local multi-file references.
|
||||||
|
- Added operation navigation, security inventory, schema and exchange examples.
|
||||||
|
- Added inert curl, Fetch and Python request text and conservative comparisons.
|
||||||
|
- Added HAR/raw-exchange inventory, offline PWA and deterministic release ZIP.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
Keep parsing bounded, output inert, and network execution absent. Parser or
|
||||||
|
reference changes need malformed, traversal, alias, cycle and limit tests.
|
||||||
|
Generation must disclose loss or heuristics. Run `npm run check` and both
|
||||||
|
Playwright projects, and update the changelog/security 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,4 @@
|
|||||||
|
# Licence materials
|
||||||
|
|
||||||
|
`../LICENSE` contains GPL-3.0-or-later terms. Release builds add an exact
|
||||||
|
`npm-runtime-licenses.txt` generated from locked runtime packages.
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,41 @@
|
|||||||
|
# API Tools
|
||||||
|
|
||||||
|
API Tools is a local-first OpenAPI workbench. Version 0.1.0 parses bounded JSON
|
||||||
|
or YAML OpenAPI 3.0/3.1 descriptions, navigates operations, resolves `$ref`
|
||||||
|
values from explicitly supplied local files, inventories security schemes,
|
||||||
|
generates schema/request/response examples and inert client command text,
|
||||||
|
compares revisions, and summarizes saved HTTP exchanges or HAR 1.2 files.
|
||||||
|
|
||||||
|
It never executes HTTP, follows a URL, resolves a remote reference, stores a
|
||||||
|
credential or loads an external asset. Generated curl, Fetch and Python snippets
|
||||||
|
are text for review and may reproduce untrusted description values safely
|
||||||
|
quoted for their target syntax.
|
||||||
|
|
||||||
|
## Development and release
|
||||||
|
|
||||||
|
Requires Node.js 22+ and npm 11+.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
npm ci
|
||||||
|
npm run check
|
||||||
|
npm run test:browser
|
||||||
|
npm run release:artifact
|
||||||
|
```
|
||||||
|
|
||||||
|
The release command writes deterministic `release/api-tools-0.1.0.zip` and a
|
||||||
|
SHA-256 sidecar. Relative assets are tested at `/deep/nested/api/`.
|
||||||
|
|
||||||
|
## v0.1 boundary
|
||||||
|
|
||||||
|
- JSON/YAML files up to 4 MiB each, 20 files/16 MiB per selected workspace,
|
||||||
|
depth 64, 100,000 values, 50 YAML aliases, 2,000 operations;
|
||||||
|
- focused OpenAPI identity/info/paths checks and remote-reference rejection;
|
||||||
|
- fragment/relative-file JSON Pointer resolution with missing/cycle reports;
|
||||||
|
- bounded sample generation for common schema composition and scalar formats;
|
||||||
|
- path/query/request/response examples and inert curl/Fetch/Python output;
|
||||||
|
- security scheme inventory, conservative operation compatibility report;
|
||||||
|
- HAR or raw saved-exchange summary without rendering bodies or secrets.
|
||||||
|
|
||||||
|
This is not a complete OpenAPI/JSON Schema validator, code generator, API
|
||||||
|
client, proxy or security scanner. See the documented limitations and review
|
||||||
|
generated values before use. Licensed under GPL-3.0-or-later.
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Security
|
||||||
|
|
||||||
|
Report vulnerabilities privately through the repository security contact.
|
||||||
|
Never paste real credentials or private HAR content into a public issue.
|
||||||
|
|
||||||
|
Descriptions, examples, URLs and exchanges are hostile inert data. API Tools
|
||||||
|
must not execute generated text or resolve external references. Deploy with the
|
||||||
|
same-origin CSP. Security fixes target the current release.
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Corresponding source
|
||||||
|
|
||||||
|
The corresponding source for API Tools 0.1.0 is available at:
|
||||||
|
|
||||||
|
https://git.add-ideas.de/lotobo/api-tools/src/tag/v0.1.0
|
||||||
|
|
||||||
|
Build with Node.js 22+, npm 11+, and `package-lock.json` by running
|
||||||
|
`npm ci && npm run release:artifact`.
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Third-party notices
|
||||||
|
|
||||||
|
API Tools is GPL-3.0-or-later. Runtime components include React and React DOM
|
||||||
|
(MIT), YAML (ISC), and the add·ideas Toolbox contract, shell and helpers (their
|
||||||
|
package metadata and corresponding source apply).
|
||||||
|
|
||||||
|
The release build generates an exact runtime notice bundle at
|
||||||
|
`LICENSES/npm-runtime-licenses.txt`. No remote assets or services are used.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Accessibility
|
||||||
|
|
||||||
|
The app uses native labels, buttons, headings, lists, tables and status/alert
|
||||||
|
regions. Operation selection and all workspaces are keyboard accessible. Focus
|
||||||
|
styles and light/dark/system themes come from the shared shell. Tables and code
|
||||||
|
panes scroll, responsive layouts collapse to one column, and reduced motion is
|
||||||
|
honoured.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Architecture
|
||||||
|
|
||||||
|
The shell lazy-loads a React workbench. Pure core modules parse and validate
|
||||||
|
JSON-like values, hold a named in-memory document map, resolve only relative
|
||||||
|
local references, collect operations, derive bounded examples, compare
|
||||||
|
operation contracts and summarize saved exchanges. No module exposes a request
|
||||||
|
executor.
|
||||||
|
|
||||||
|
JSON uses hardened shared helpers. YAML is converted with bounded alias count
|
||||||
|
and then recursively checked for depth, node count, dangerous keys and plain
|
||||||
|
JSON values. Rendering uses React text nodes and read-only textareas. The
|
||||||
|
same-origin service worker caches only packaged application resources.
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Privacy and security
|
||||||
|
|
||||||
|
Descriptions and exchanges remain in memory and are never transmitted or
|
||||||
|
persisted. All remote/absolute `$ref` forms fail closed. Displayed URLs are text,
|
||||||
|
not links. There is no Try It button, OAuth flow, DNS lookup, HTTP execution,
|
||||||
|
telemetry or external asset.
|
||||||
|
|
||||||
|
HAR and saved exchanges commonly contain tokens, cookies, personal data and
|
||||||
|
payloads. The summary does not render header values, yet the source editor still
|
||||||
|
contains them. Clear it before sharing. Generated examples are heuristic and
|
||||||
|
must not be treated as valid production data. Validation and compatibility
|
||||||
|
checks cover a useful subset, not every OpenAPI or JSON Schema rule.
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="API Tools"><path fill="#5b4ec4" d="M11 4h30l12 12v44H11z"/><path fill="#fff" opacity=".28" d="M41 4v14h12"/><path fill="none" stroke="#fff" stroke-width="4" stroke-linecap="round" d="M19 34h7m12 0h7M30 25l-5 18m14-18-5 18"/></svg>
|
||||||
|
After Width: | Height: | Size: 314 B |
@@ -0,0 +1,18 @@
|
|||||||
|
{
|
||||||
|
"name": "API Tools",
|
||||||
|
"short_name": "API",
|
||||||
|
"description": "Inspect and compare OpenAPI descriptions 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,59 @@
|
|||||||
|
const CACHE_PREFIX = "api-tools-shell-";
|
||||||
|
const CACHE_NAME = CACHE_PREFIX + "0.1.0";
|
||||||
|
const CORE = [
|
||||||
|
"./",
|
||||||
|
"./manifest.webmanifest",
|
||||||
|
"./favicon.svg",
|
||||||
|
"./toolbox-app.json",
|
||||||
|
];
|
||||||
|
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.api-tools",
|
||||||
|
"name": "API Tools",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Inspect and compare API descriptions locally.",
|
||||||
|
"entry": "./",
|
||||||
|
"icon": "./favicon.svg",
|
||||||
|
"categories": ["developer", "data", "network"],
|
||||||
|
"tags": ["openapi", "swagger", "har", "schema", "http"],
|
||||||
|
"integration": {
|
||||||
|
"contextVersion": 1,
|
||||||
|
"launchModes": ["navigate", "new-tab"],
|
||||||
|
"embedding": "unsupported"
|
||||||
|
},
|
||||||
|
"requirements": {
|
||||||
|
"secureContext": false,
|
||||||
|
"workers": false,
|
||||||
|
"indexedDb": false,
|
||||||
|
"crossOriginIsolated": false,
|
||||||
|
"topLevelContext": false
|
||||||
|
},
|
||||||
|
"privacy": {
|
||||||
|
"processing": "local",
|
||||||
|
"fileUploads": true,
|
||||||
|
"telemetry": false,
|
||||||
|
"label": "Descriptions and exchanges stay local; generated requests are never executed."
|
||||||
|
},
|
||||||
|
"source": {
|
||||||
|
"repository": "https://git.add-ideas.de/lotobo/api-tools",
|
||||||
|
"license": "GPL-3.0-or-later"
|
||||||
|
},
|
||||||
|
"actions": [
|
||||||
|
{
|
||||||
|
"id": "source",
|
||||||
|
"label": "Source",
|
||||||
|
"url": "https://git.add-ideas.de/lotobo/api-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 === b.name ? 0 : a.name < b.name ? -1 : 1),
|
||||||
|
)) {
|
||||||
|
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 === b ? 0 : a < b ? -1 : 1),
|
||||||
|
)) {
|
||||||
|
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,69 @@
|
|||||||
|
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/api/";
|
||||||
|
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);
|
||||||
|
const cacheControl = normalized.startsWith("assets/")
|
||||||
|
? "public, max-age=31536000, immutable"
|
||||||
|
: "no-cache";
|
||||||
|
response.writeHead(200, {
|
||||||
|
"Content-Type":
|
||||||
|
types.get(path.extname(file)) ?? "application/octet-stream",
|
||||||
|
"Cache-Control": cacheControl,
|
||||||
|
...headers,
|
||||||
|
});
|
||||||
|
response.end(content);
|
||||||
|
} catch {
|
||||||
|
response.writeHead(404, { "Content-Type": "text/plain; charset=utf-8" });
|
||||||
|
response.end("Not found");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
server.listen(4196, "127.0.0.1", () => console.log("Test server ready"));
|
||||||
+28
@@ -0,0 +1,28 @@
|
|||||||
|
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">Preparing API Tools…</p>}>
|
||||||
|
<Workbench />
|
||||||
|
</Suspense>
|
||||||
|
</AppShell>
|
||||||
|
<HelpDialog open={helpOpen} onClose={() => setHelpOpen(false)} />
|
||||||
|
</ErrorBoundary>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
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>API 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,49 @@
|
|||||||
|
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 API Tools</h2>
|
||||||
|
</div>
|
||||||
|
<button type="button" onClick={onClose} aria-label="Close help">
|
||||||
|
×
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<p>
|
||||||
|
Open JSON or YAML OpenAPI 3.0/3.1 descriptions, resolve references from
|
||||||
|
files you explicitly add, inspect operations and security schemes,
|
||||||
|
generate examples, and compare revisions.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Generated curl, Fetch and Python requests are inert text. Version 0.1
|
||||||
|
never executes HTTP, follows URLs, or resolves remote references.
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
Validation is a focused structural review, not full conformance
|
||||||
|
certification. Inputs, nesting, aliases, references, generated samples
|
||||||
|
and comparisons are bounded.
|
||||||
|
</p>
|
||||||
|
</dialog>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,684 @@
|
|||||||
|
import { useMemo, useState, type ChangeEvent } from "react";
|
||||||
|
import {
|
||||||
|
stableStringify,
|
||||||
|
triggerBlobDownload,
|
||||||
|
} from "@add-ideas/toolbox-helpers";
|
||||||
|
import { compareApis } from "../core/compare";
|
||||||
|
import {
|
||||||
|
inspectHar,
|
||||||
|
inspectRawExchange,
|
||||||
|
type ExchangeSummary,
|
||||||
|
} from "../core/har";
|
||||||
|
import {
|
||||||
|
collectOperations,
|
||||||
|
operationExample,
|
||||||
|
securityInventory,
|
||||||
|
} from "../core/operations";
|
||||||
|
import { parseApiDocument, validateOpenApi } from "../core/parse";
|
||||||
|
import { createWorkspace } from "../core/refs";
|
||||||
|
import type { ApiDocument, ApiOperation } from "../core/types";
|
||||||
|
|
||||||
|
const SAMPLE = `openapi: 3.1.0
|
||||||
|
info:
|
||||||
|
title: Local Library API
|
||||||
|
version: 1.0.0
|
||||||
|
servers:
|
||||||
|
- url: https://api.example.test
|
||||||
|
paths:
|
||||||
|
/books/{bookId}:
|
||||||
|
parameters:
|
||||||
|
- name: bookId
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema: { type: string, example: book-42 }
|
||||||
|
get:
|
||||||
|
operationId: getBook
|
||||||
|
summary: Read one book
|
||||||
|
tags: [Books]
|
||||||
|
security: [{ bearerAuth: [] }]
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema: { $ref: "#/components/schemas/Book" }
|
||||||
|
patch:
|
||||||
|
operationId: updateBook
|
||||||
|
summary: Update one book
|
||||||
|
requestBody:
|
||||||
|
required: true
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
title: { type: string, example: Analytical Engines }
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Updated
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema: { $ref: "#/components/schemas/Book" }
|
||||||
|
components:
|
||||||
|
securitySchemes:
|
||||||
|
bearerAuth: { type: http, scheme: bearer, bearerFormat: JWT }
|
||||||
|
schemas:
|
||||||
|
Book:
|
||||||
|
type: object
|
||||||
|
required: [id, title]
|
||||||
|
properties:
|
||||||
|
id: { type: string, example: book-42 }
|
||||||
|
title: { type: string, example: Computing Machinery }
|
||||||
|
published: { type: string, format: date }
|
||||||
|
`;
|
||||||
|
|
||||||
|
const COMPARE_SAMPLE = SAMPLE.replace(
|
||||||
|
"version: 1.0.0",
|
||||||
|
"version: 1.1.0",
|
||||||
|
).replace(
|
||||||
|
" patch:\n",
|
||||||
|
' delete:\n summary: Delete one book\n responses:\n "204": { description: Deleted }\n patch:\n',
|
||||||
|
);
|
||||||
|
const HAR_SAMPLE = `{"log":{"version":"1.2","creator":{"name":"fixture","version":"1"},"entries":[{"time":12.5,"request":{"method":"GET","url":"https://api.example.test/books/book-42","headers":[]},"response":{"status":200,"headers":[],"content":{"size":42,"mimeType":"application/json"}}}]}}`;
|
||||||
|
|
||||||
|
type View = "operations" | "security" | "compare" | "exchanges" | "source";
|
||||||
|
|
||||||
|
function downloadJson(value: unknown, filename: string) {
|
||||||
|
triggerBlobDownload(
|
||||||
|
new Blob([stableStringify(value, 2)], { type: "application/json" }),
|
||||||
|
filename,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function OperationList({
|
||||||
|
operations,
|
||||||
|
selected,
|
||||||
|
onSelect,
|
||||||
|
}: {
|
||||||
|
operations: ApiOperation[];
|
||||||
|
selected?: string;
|
||||||
|
onSelect: (key: string) => void;
|
||||||
|
}) {
|
||||||
|
return (
|
||||||
|
<ul className="operation-list">
|
||||||
|
{operations.map((operation) => (
|
||||||
|
<li key={operation.key}>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
aria-pressed={operation.key === selected}
|
||||||
|
onClick={() => onSelect(operation.key)}
|
||||||
|
>
|
||||||
|
<span className={`method method-${operation.method.toLowerCase()}`}>
|
||||||
|
{operation.method}
|
||||||
|
</span>
|
||||||
|
<span>
|
||||||
|
<strong>{operation.path}</strong>
|
||||||
|
<small>
|
||||||
|
{operation.summary ?? operation.operationId ?? "No summary"}
|
||||||
|
</small>
|
||||||
|
</span>
|
||||||
|
</button>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function Workbench() {
|
||||||
|
const initial = useMemo(() => parseApiDocument(SAMPLE, "openapi.yaml"), []);
|
||||||
|
const [source, setSource] = useState(SAMPLE);
|
||||||
|
const [entry, setEntry] = useState<ApiDocument>(initial);
|
||||||
|
const [supporting, setSupporting] = useState<ApiDocument[]>([]);
|
||||||
|
const [error, setError] = useState<string>();
|
||||||
|
const [view, setView] = useState<View>("operations");
|
||||||
|
const [query, setQuery] = useState("");
|
||||||
|
const [selectedKey, setSelectedKey] = useState("GET /books/{bookId}");
|
||||||
|
const [compareSource, setCompareSource] = useState(COMPARE_SAMPLE);
|
||||||
|
const [comparison, setComparison] = useState(() =>
|
||||||
|
compareApis(initial, parseApiDocument(COMPARE_SAMPLE, "comparison.yaml")),
|
||||||
|
);
|
||||||
|
const [exchangeSource, setExchangeSource] = useState(HAR_SAMPLE);
|
||||||
|
const [exchanges, setExchanges] = useState<ExchangeSummary[]>(() =>
|
||||||
|
inspectHar(HAR_SAMPLE),
|
||||||
|
);
|
||||||
|
const [exchangeError, setExchangeError] = useState<string>();
|
||||||
|
|
||||||
|
const workspace = useMemo(
|
||||||
|
() => createWorkspace(entry, supporting),
|
||||||
|
[entry, supporting],
|
||||||
|
);
|
||||||
|
const problems = useMemo(() => validateOpenApi(entry), [entry]);
|
||||||
|
const operations = useMemo(() => collectOperations(entry.value), [entry]);
|
||||||
|
const visibleOperations = useMemo(() => {
|
||||||
|
const needle = query.trim().toLowerCase();
|
||||||
|
return needle
|
||||||
|
? operations.filter((operation) =>
|
||||||
|
[
|
||||||
|
operation.key,
|
||||||
|
operation.operationId,
|
||||||
|
operation.summary,
|
||||||
|
...operation.tags,
|
||||||
|
].some((value) => value?.toLowerCase().includes(needle)),
|
||||||
|
)
|
||||||
|
: operations;
|
||||||
|
}, [operations, query]);
|
||||||
|
const selected =
|
||||||
|
operations.find((operation) => operation.key === selectedKey) ??
|
||||||
|
operations[0];
|
||||||
|
const example = useMemo(
|
||||||
|
() => (selected ? operationExample(workspace, selected) : undefined),
|
||||||
|
[selected, workspace],
|
||||||
|
);
|
||||||
|
const schemes = useMemo(() => securityInventory(entry.value), [entry]);
|
||||||
|
|
||||||
|
const analyze = () => {
|
||||||
|
try {
|
||||||
|
const parsed = parseApiDocument(source, entry.filename);
|
||||||
|
setEntry(parsed);
|
||||||
|
setError(undefined);
|
||||||
|
} catch (reason) {
|
||||||
|
setError(
|
||||||
|
reason instanceof Error
|
||||||
|
? reason.message
|
||||||
|
: "The description could not be parsed.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const chooseEntry = (filename: string) => {
|
||||||
|
const documents = [entry, ...supporting];
|
||||||
|
const selected = documents.find(
|
||||||
|
(document) => document.filename === filename,
|
||||||
|
);
|
||||||
|
if (!selected) return;
|
||||||
|
setEntry(selected);
|
||||||
|
setSupporting(documents.filter((document) => document !== selected));
|
||||||
|
setSource(selected.source);
|
||||||
|
setError(undefined);
|
||||||
|
};
|
||||||
|
const loadFiles = async (event: ChangeEvent<HTMLInputElement>) => {
|
||||||
|
const files = [...(event.target.files ?? [])];
|
||||||
|
event.target.value = "";
|
||||||
|
if (!files.length) return;
|
||||||
|
if (
|
||||||
|
files.length > 20 ||
|
||||||
|
files.some((file) => file.size > 4 * 1024 * 1024) ||
|
||||||
|
files.reduce((sum, file) => sum + file.size, 0) > 16 * 1024 * 1024
|
||||||
|
) {
|
||||||
|
setError("Use at most 20 local files, 4 MiB each and 16 MiB total.");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
const documents = await Promise.all(
|
||||||
|
files.map(async (file) =>
|
||||||
|
parseApiDocument(await file.text(), file.name),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
setEntry(documents[0]!);
|
||||||
|
setSource(documents[0]!.source);
|
||||||
|
setSupporting(documents.slice(1));
|
||||||
|
setError(undefined);
|
||||||
|
} catch (reason) {
|
||||||
|
setError(
|
||||||
|
reason instanceof Error
|
||||||
|
? reason.message
|
||||||
|
: "The local workspace could not be opened.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const runComparison = () => {
|
||||||
|
try {
|
||||||
|
setComparison(
|
||||||
|
compareApis(entry, parseApiDocument(compareSource, "comparison.yaml")),
|
||||||
|
);
|
||||||
|
setError(undefined);
|
||||||
|
} catch (reason) {
|
||||||
|
setError(
|
||||||
|
reason instanceof Error
|
||||||
|
? reason.message
|
||||||
|
: "The comparison description could not be parsed.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const inspectExchange = () => {
|
||||||
|
try {
|
||||||
|
const value = /^\s*\{/u.test(exchangeSource)
|
||||||
|
? inspectHar(exchangeSource)
|
||||||
|
: inspectRawExchange(exchangeSource);
|
||||||
|
setExchanges(value);
|
||||||
|
setExchangeError(undefined);
|
||||||
|
} catch (reason) {
|
||||||
|
setExchangeError(
|
||||||
|
reason instanceof Error
|
||||||
|
? reason.message
|
||||||
|
: "The saved exchange could not be inspected.",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<main className="workbench">
|
||||||
|
<section className="hero">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">Offline API description laboratory</p>
|
||||||
|
<h1>API Tools</h1>
|
||||||
|
<p>
|
||||||
|
Navigate OpenAPI descriptions, resolve explicitly supplied local
|
||||||
|
references, derive examples and compare revisions—without sending a
|
||||||
|
request.
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<span className="privacy-pill">Generation only</span>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section
|
||||||
|
className="panel input-panel"
|
||||||
|
aria-labelledby="description-title"
|
||||||
|
>
|
||||||
|
<div className="panel-heading">
|
||||||
|
<div>
|
||||||
|
<h2 id="description-title">API workspace</h2>
|
||||||
|
<p>
|
||||||
|
{entry.filename} · {entry.format.toUpperCase()} ·{" "}
|
||||||
|
{supporting.length} supporting file
|
||||||
|
{supporting.length === 1 ? "" : "s"}
|
||||||
|
</p>
|
||||||
|
{supporting.length ? (
|
||||||
|
<label className="entry-select">
|
||||||
|
Entry description
|
||||||
|
<select
|
||||||
|
aria-label="Entry description"
|
||||||
|
value={entry.filename}
|
||||||
|
onChange={(event) => chooseEntry(event.target.value)}
|
||||||
|
>
|
||||||
|
{[entry, ...supporting].map((document) => (
|
||||||
|
<option key={document.filename} value={document.filename}>
|
||||||
|
{document.filename}
|
||||||
|
</option>
|
||||||
|
))}
|
||||||
|
</select>
|
||||||
|
</label>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
<label className="button file-button">
|
||||||
|
Open local files
|
||||||
|
<input
|
||||||
|
data-testid="api-file-input"
|
||||||
|
type="file"
|
||||||
|
multiple
|
||||||
|
accept=".json,.yaml,.yml,application/json,application/yaml,text/yaml"
|
||||||
|
onChange={(event) => void loadFiles(event)}
|
||||||
|
/>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<textarea
|
||||||
|
data-testid="source-editor"
|
||||||
|
aria-label="OpenAPI source"
|
||||||
|
value={source}
|
||||||
|
onChange={(event) => setSource(event.target.value)}
|
||||||
|
rows={11}
|
||||||
|
spellCheck={false}
|
||||||
|
/>
|
||||||
|
<div className="action-row">
|
||||||
|
<button className="primary-button" type="button" onClick={analyze}>
|
||||||
|
Analyse description
|
||||||
|
</button>
|
||||||
|
<span className="muted">
|
||||||
|
JSON/YAML · 4 MiB/file · local $ref only
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
{error ? (
|
||||||
|
<p className="error" role="alert">
|
||||||
|
{error} The last successful model remains visible.
|
||||||
|
</p>
|
||||||
|
) : (
|
||||||
|
<p
|
||||||
|
className={
|
||||||
|
problems.some((item) => item.level === "error")
|
||||||
|
? "warning"
|
||||||
|
: "success"
|
||||||
|
}
|
||||||
|
role="status"
|
||||||
|
>
|
||||||
|
{problems.filter((item) => item.level === "error").length} errors,{" "}
|
||||||
|
{problems.filter((item) => item.level === "warning").length}{" "}
|
||||||
|
warnings · {operations.length} operations.
|
||||||
|
</p>
|
||||||
|
)}
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<nav className="tabs" aria-label="API workspaces">
|
||||||
|
{(
|
||||||
|
["operations", "security", "compare", "exchanges", "source"] as View[]
|
||||||
|
).map((name) => (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
key={name}
|
||||||
|
aria-pressed={view === name}
|
||||||
|
onClick={() => setView(name)}
|
||||||
|
>
|
||||||
|
{name[0]!.toUpperCase() + name.slice(1)}
|
||||||
|
</button>
|
||||||
|
))}
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
{view === "operations" ? (
|
||||||
|
<section className="workspace-grid operation-workspace">
|
||||||
|
<aside className="panel">
|
||||||
|
<div className="panel-heading">
|
||||||
|
<h2>Operations</h2>
|
||||||
|
<span className="count-pill">{visibleOperations.length}</span>
|
||||||
|
</div>
|
||||||
|
<input
|
||||||
|
className="search"
|
||||||
|
aria-label="Search operations"
|
||||||
|
placeholder="Path, method, tag or operation ID"
|
||||||
|
value={query}
|
||||||
|
onChange={(event) => setQuery(event.target.value)}
|
||||||
|
/>
|
||||||
|
<OperationList
|
||||||
|
operations={visibleOperations}
|
||||||
|
selected={selected?.key}
|
||||||
|
onSelect={setSelectedKey}
|
||||||
|
/>
|
||||||
|
</aside>
|
||||||
|
<article className="panel operation-detail">
|
||||||
|
{selected && example ? (
|
||||||
|
<>
|
||||||
|
<div className="panel-heading">
|
||||||
|
<div>
|
||||||
|
<p className="eyebrow">{selected.method}</p>
|
||||||
|
<h2>{selected.path}</h2>
|
||||||
|
<p>
|
||||||
|
{selected.summary ??
|
||||||
|
selected.operationId ??
|
||||||
|
"No description"}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() =>
|
||||||
|
downloadJson(
|
||||||
|
{ operation: selected.key, ...example },
|
||||||
|
"api-example.json",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Download example
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
<dl className="facts">
|
||||||
|
<div>
|
||||||
|
<dt>Operation ID</dt>
|
||||||
|
<dd>{selected.operationId ?? "—"}</dd>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<dt>Request URL</dt>
|
||||||
|
<dd>{example.url}</dd>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<dt>Response</dt>
|
||||||
|
<dd>{example.responseStatus ?? "—"}</dd>
|
||||||
|
</div>
|
||||||
|
</dl>
|
||||||
|
{example.body !== undefined ? (
|
||||||
|
<>
|
||||||
|
<h3>Generated request body</h3>
|
||||||
|
<pre>{stableStringify(example.body, 2)}</pre>
|
||||||
|
</>
|
||||||
|
) : null}
|
||||||
|
{example.response !== undefined ? (
|
||||||
|
<>
|
||||||
|
<h3>Generated response body</h3>
|
||||||
|
<pre>{stableStringify(example.response, 2)}</pre>
|
||||||
|
</>
|
||||||
|
) : null}
|
||||||
|
<h3>Inert command text</h3>
|
||||||
|
<label>
|
||||||
|
curl
|
||||||
|
<textarea readOnly rows={4} value={example.commands.curl} />
|
||||||
|
</label>
|
||||||
|
<label>
|
||||||
|
Fetch
|
||||||
|
<textarea readOnly rows={6} value={example.commands.fetch} />
|
||||||
|
</label>
|
||||||
|
<label>
|
||||||
|
Python requests
|
||||||
|
<textarea readOnly rows={4} value={example.commands.python} />
|
||||||
|
</label>
|
||||||
|
{example.notices.map((notice) => (
|
||||||
|
<p className="warning" key={notice}>
|
||||||
|
{notice}
|
||||||
|
</p>
|
||||||
|
))}
|
||||||
|
</>
|
||||||
|
) : (
|
||||||
|
<p className="empty">No operation selected.</p>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
</section>
|
||||||
|
) : null}
|
||||||
|
|
||||||
|
{view === "security" ? (
|
||||||
|
<section className="workspace-grid">
|
||||||
|
<article className="panel">
|
||||||
|
<div className="panel-heading">
|
||||||
|
<div>
|
||||||
|
<h2>Security schemes</h2>
|
||||||
|
<p>Inventory only; no credentials are entered or sent.</p>
|
||||||
|
</div>
|
||||||
|
<span className="count-pill">{schemes.length}</span>
|
||||||
|
</div>
|
||||||
|
{schemes.length ? (
|
||||||
|
<ul className="cards">
|
||||||
|
{schemes.map((scheme) => (
|
||||||
|
<li key={scheme.name}>
|
||||||
|
<strong>{scheme.name}</strong>
|
||||||
|
<span>{scheme.type}</span>
|
||||||
|
<p>{scheme.detail}</p>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
) : (
|
||||||
|
<p className="empty">No component security schemes were found.</p>
|
||||||
|
)}
|
||||||
|
</article>
|
||||||
|
<article className="panel">
|
||||||
|
<h2>Focused validation</h2>
|
||||||
|
<ul className="diagnostic-list">
|
||||||
|
{problems.map((problem, index) => (
|
||||||
|
<li className={problem.level} key={`${problem.path}-${index}`}>
|
||||||
|
<code>{problem.path}</code>
|
||||||
|
<strong>{problem.message}</strong>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</article>
|
||||||
|
</section>
|
||||||
|
) : null}
|
||||||
|
|
||||||
|
{view === "compare" ? (
|
||||||
|
<section className="workspace-grid">
|
||||||
|
<article className="panel">
|
||||||
|
<h2>Comparison revision</h2>
|
||||||
|
<p>
|
||||||
|
Paste another JSON/YAML OpenAPI description. The comparison is
|
||||||
|
operation-aware and deliberately conservative.
|
||||||
|
</p>
|
||||||
|
<textarea
|
||||||
|
aria-label="Comparison OpenAPI source"
|
||||||
|
value={compareSource}
|
||||||
|
onChange={(event) => setCompareSource(event.target.value)}
|
||||||
|
rows={20}
|
||||||
|
spellCheck={false}
|
||||||
|
/>
|
||||||
|
<button
|
||||||
|
className="primary-button top-gap"
|
||||||
|
type="button"
|
||||||
|
onClick={runComparison}
|
||||||
|
>
|
||||||
|
Compare revisions
|
||||||
|
</button>
|
||||||
|
</article>
|
||||||
|
<article className="panel">
|
||||||
|
<div className="panel-heading">
|
||||||
|
<h2>Change report</h2>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() =>
|
||||||
|
downloadJson(comparison, "openapi-change-report.json")
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Download JSON
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
{comparison.length ? (
|
||||||
|
<ul className="change-list">
|
||||||
|
{comparison.map((change, index) => (
|
||||||
|
<li className={change.level} key={`${change.path}-${index}`}>
|
||||||
|
<strong>{change.level}</strong>
|
||||||
|
<code>{change.path}</code>
|
||||||
|
<p>{change.message}</p>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
) : (
|
||||||
|
<p className="success">No operation-level changes detected.</p>
|
||||||
|
)}
|
||||||
|
<p className="disclosure">
|
||||||
|
This does not fully compare schema compatibility, callbacks,
|
||||||
|
links, webhooks, extensions, serialization or behavioural
|
||||||
|
contracts.
|
||||||
|
</p>
|
||||||
|
</article>
|
||||||
|
</section>
|
||||||
|
) : null}
|
||||||
|
|
||||||
|
{view === "exchanges" ? (
|
||||||
|
<section className="workspace-grid">
|
||||||
|
<article className="panel">
|
||||||
|
<h2>Saved exchange / HAR</h2>
|
||||||
|
<p>
|
||||||
|
Paste a HAR 1.2 JSON object or a raw request followed by “---
|
||||||
|
response ---”. URLs and headers remain inert.
|
||||||
|
</p>
|
||||||
|
<textarea
|
||||||
|
aria-label="Saved HTTP exchange"
|
||||||
|
value={exchangeSource}
|
||||||
|
onChange={(event) => setExchangeSource(event.target.value)}
|
||||||
|
rows={16}
|
||||||
|
spellCheck={false}
|
||||||
|
/>
|
||||||
|
<button
|
||||||
|
className="primary-button top-gap"
|
||||||
|
type="button"
|
||||||
|
onClick={inspectExchange}
|
||||||
|
>
|
||||||
|
Inspect saved exchange
|
||||||
|
</button>
|
||||||
|
{exchangeError ? (
|
||||||
|
<p className="error" role="alert">
|
||||||
|
{exchangeError}
|
||||||
|
</p>
|
||||||
|
) : null}
|
||||||
|
</article>
|
||||||
|
<article className="panel">
|
||||||
|
<div className="panel-heading">
|
||||||
|
<h2>Exchange inventory</h2>
|
||||||
|
<span className="count-pill">{exchanges.length}</span>
|
||||||
|
</div>
|
||||||
|
<div className="table-scroll" tabIndex={0}>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Method</th>
|
||||||
|
<th>URL</th>
|
||||||
|
<th>Status</th>
|
||||||
|
<th>Time</th>
|
||||||
|
<th>Size</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
{exchanges.map((exchange, index) => (
|
||||||
|
<tr key={index}>
|
||||||
|
<th>{exchange.method}</th>
|
||||||
|
<td>{exchange.url}</td>
|
||||||
|
<td>{exchange.status ?? "—"}</td>
|
||||||
|
<td>
|
||||||
|
{exchange.duration === undefined
|
||||||
|
? "—"
|
||||||
|
: `${exchange.duration} ms`}
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
{exchange.responseBytes === undefined
|
||||||
|
? "—"
|
||||||
|
: `${exchange.responseBytes} B`}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<p className="disclosure">
|
||||||
|
Authorization and cookie values are not rendered by this summary,
|
||||||
|
but the pasted source can still contain secrets. Clear it before
|
||||||
|
sharing screenshots or reports.
|
||||||
|
</p>
|
||||||
|
</article>
|
||||||
|
</section>
|
||||||
|
) : null}
|
||||||
|
|
||||||
|
{view === "source" ? (
|
||||||
|
<section className="workspace-grid">
|
||||||
|
<article className="panel">
|
||||||
|
<h2>Local document set</h2>
|
||||||
|
<ul className="cards">
|
||||||
|
<li>
|
||||||
|
<strong>{entry.filename}</strong>
|
||||||
|
<span>entry · {entry.format}</span>
|
||||||
|
<p>{entry.source.length.toLocaleString()} characters</p>
|
||||||
|
</li>
|
||||||
|
{supporting.map((document) => (
|
||||||
|
<li key={document.filename}>
|
||||||
|
<strong>{document.filename}</strong>
|
||||||
|
<span>supporting · {document.format}</span>
|
||||||
|
<p>{document.source.length.toLocaleString()} characters</p>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</article>
|
||||||
|
<article className="panel">
|
||||||
|
<h2>Network boundary</h2>
|
||||||
|
<p className="disclosure">
|
||||||
|
Only fragment and relative-file references can resolve, and only
|
||||||
|
against this explicitly supplied set. HTTP(S), scheme-relative,
|
||||||
|
absolute and missing references fail closed. API Tools never
|
||||||
|
executes its generated commands.
|
||||||
|
</p>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
onClick={() =>
|
||||||
|
downloadJson(
|
||||||
|
{
|
||||||
|
validation: problems,
|
||||||
|
operations: operations.map(
|
||||||
|
({ key, operationId, summary, tags }) => ({
|
||||||
|
key,
|
||||||
|
operationId,
|
||||||
|
summary,
|
||||||
|
tags,
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
securitySchemes: schemes,
|
||||||
|
},
|
||||||
|
"api-inspection-report.json",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
>
|
||||||
|
Download inspection report
|
||||||
|
</button>
|
||||||
|
</article>
|
||||||
|
</section>
|
||||||
|
) : null}
|
||||||
|
</main>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
import { collectOperations } from "./operations";
|
||||||
|
import type { ApiDocument, ApiOperation, JsonObject, JsonValue } from "./types";
|
||||||
|
|
||||||
|
export interface ApiChange {
|
||||||
|
level: "breaking" | "non-breaking" | "review";
|
||||||
|
path: string;
|
||||||
|
message: string;
|
||||||
|
}
|
||||||
|
function asObject(value: JsonValue | undefined): JsonObject | undefined {
|
||||||
|
return value && typeof value === "object" && !Array.isArray(value)
|
||||||
|
? value
|
||||||
|
: undefined;
|
||||||
|
}
|
||||||
|
function requiredParameters(operation: ApiOperation): Set<string> {
|
||||||
|
const values = [
|
||||||
|
...operation.inheritedParameters,
|
||||||
|
...(Array.isArray(operation.value.parameters)
|
||||||
|
? operation.value.parameters
|
||||||
|
: []),
|
||||||
|
];
|
||||||
|
return new Set(
|
||||||
|
values
|
||||||
|
.map(asObject)
|
||||||
|
.filter((item): item is JsonObject =>
|
||||||
|
Boolean(item && item.required === true),
|
||||||
|
)
|
||||||
|
.map((item) => `${String(item.in)}:${String(item.name)}`),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
function responseCodes(operation: ApiOperation): Set<string> {
|
||||||
|
return new Set(Object.keys(asObject(operation.value.responses) ?? {}));
|
||||||
|
}
|
||||||
|
|
||||||
|
export function compareApis(
|
||||||
|
before: ApiDocument,
|
||||||
|
after: ApiDocument,
|
||||||
|
): ApiChange[] {
|
||||||
|
const prior = new Map(
|
||||||
|
collectOperations(before.value).map((operation) => [
|
||||||
|
operation.key,
|
||||||
|
operation,
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
const next = new Map(
|
||||||
|
collectOperations(after.value).map((operation) => [
|
||||||
|
operation.key,
|
||||||
|
operation,
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
const changes: ApiChange[] = [];
|
||||||
|
for (const [key, operation] of prior) {
|
||||||
|
const current = next.get(key);
|
||||||
|
if (!current) {
|
||||||
|
changes.push({
|
||||||
|
level: "breaking",
|
||||||
|
path: key,
|
||||||
|
message: "Operation was removed.",
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
for (const parameter of requiredParameters(current))
|
||||||
|
if (!requiredParameters(operation).has(parameter))
|
||||||
|
changes.push({
|
||||||
|
level: "breaking",
|
||||||
|
path: key,
|
||||||
|
message: `Required parameter ${parameter} was added.`,
|
||||||
|
});
|
||||||
|
const oldBody = asObject(operation.value.requestBody),
|
||||||
|
newBody = asObject(current.value.requestBody);
|
||||||
|
if (newBody?.required === true && oldBody?.required !== true)
|
||||||
|
changes.push({
|
||||||
|
level: "breaking",
|
||||||
|
path: key,
|
||||||
|
message: "Request body became required.",
|
||||||
|
});
|
||||||
|
for (const code of responseCodes(operation))
|
||||||
|
if (!responseCodes(current).has(code))
|
||||||
|
changes.push({
|
||||||
|
level: "breaking",
|
||||||
|
path: key,
|
||||||
|
message: `Response ${code} was removed.`,
|
||||||
|
});
|
||||||
|
if (
|
||||||
|
JSON.stringify(operation.value) !== JSON.stringify(current.value) &&
|
||||||
|
!changes.some((change) => change.path === key)
|
||||||
|
)
|
||||||
|
changes.push({
|
||||||
|
level: "review",
|
||||||
|
path: key,
|
||||||
|
message: "Operation content changed; review schemas and semantics.",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
for (const key of next.keys())
|
||||||
|
if (!prior.has(key))
|
||||||
|
changes.push({
|
||||||
|
level: "non-breaking",
|
||||||
|
path: key,
|
||||||
|
message: "Operation was added.",
|
||||||
|
});
|
||||||
|
return changes.slice(0, 5_000);
|
||||||
|
}
|
||||||
+108
@@ -0,0 +1,108 @@
|
|||||||
|
import { assertBoundedText, safeJsonParse } from "@add-ideas/toolbox-helpers";
|
||||||
|
import type { JsonObject, JsonValue } from "./types";
|
||||||
|
|
||||||
|
function asObject(value: JsonValue | undefined): JsonObject | undefined {
|
||||||
|
return value && typeof value === "object" && !Array.isArray(value)
|
||||||
|
? value
|
||||||
|
: undefined;
|
||||||
|
}
|
||||||
|
export interface ExchangeSummary {
|
||||||
|
method: string;
|
||||||
|
url: string;
|
||||||
|
status?: number;
|
||||||
|
duration?: number;
|
||||||
|
requestHeaders: number;
|
||||||
|
responseHeaders: number;
|
||||||
|
requestBytes?: number;
|
||||||
|
responseBytes?: number;
|
||||||
|
mimeType?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function inspectHar(source: string): ExchangeSummary[] {
|
||||||
|
const value = safeJsonParse(
|
||||||
|
assertBoundedText(source, 8 * 1024 * 1024, "HAR length"),
|
||||||
|
{
|
||||||
|
maxTextChars: 8 * 1024 * 1024,
|
||||||
|
maxDepth: 64,
|
||||||
|
maxNodes: 200_000,
|
||||||
|
rejectDangerousKeys: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
const root = asObject(value),
|
||||||
|
log = asObject(root?.log);
|
||||||
|
if (!log || !Array.isArray(log.entries))
|
||||||
|
throw new TypeError("Expected a HAR object with log.entries");
|
||||||
|
if (log.entries.length > 2_000)
|
||||||
|
throw new RangeError("HAR entry count exceeds 2,000");
|
||||||
|
return log.entries.map((raw, index) => {
|
||||||
|
const entry = asObject(raw),
|
||||||
|
request = asObject(entry?.request),
|
||||||
|
response = asObject(entry?.response),
|
||||||
|
content = asObject(response?.content),
|
||||||
|
postData = asObject(request?.postData);
|
||||||
|
if (
|
||||||
|
!request ||
|
||||||
|
typeof request.method !== "string" ||
|
||||||
|
typeof request.url !== "string"
|
||||||
|
)
|
||||||
|
throw new TypeError(`HAR entry ${index} lacks request method or URL`);
|
||||||
|
return {
|
||||||
|
method: request.method,
|
||||||
|
url: request.url,
|
||||||
|
status:
|
||||||
|
typeof response?.status === "number" ? response.status : undefined,
|
||||||
|
duration: typeof entry?.time === "number" ? entry.time : undefined,
|
||||||
|
requestHeaders: Array.isArray(request.headers)
|
||||||
|
? request.headers.length
|
||||||
|
: 0,
|
||||||
|
responseHeaders: Array.isArray(response?.headers)
|
||||||
|
? response.headers.length
|
||||||
|
: 0,
|
||||||
|
requestBytes:
|
||||||
|
typeof postData?.text === "string" ? postData.text.length : undefined,
|
||||||
|
responseBytes:
|
||||||
|
typeof content?.size === "number"
|
||||||
|
? content.size
|
||||||
|
: typeof content?.text === "string"
|
||||||
|
? content.text.length
|
||||||
|
: undefined,
|
||||||
|
mimeType:
|
||||||
|
typeof content?.mimeType === "string" ? content.mimeType : undefined,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function inspectRawExchange(source: string): ExchangeSummary[] {
|
||||||
|
const text = assertBoundedText(
|
||||||
|
source,
|
||||||
|
2 * 1024 * 1024,
|
||||||
|
"Saved exchange length",
|
||||||
|
).replace(/\r\n?/gu, "\n");
|
||||||
|
const [requestSource, responseSource = ""] = text.split(
|
||||||
|
/\n---+\s*response\s*---+\n/iu,
|
||||||
|
2,
|
||||||
|
);
|
||||||
|
const requestLine = requestSource?.split("\n")[0] ?? "";
|
||||||
|
const request = /^([A-Z]+)\s+(\S+)\s+HTTP\/\d(?:\.\d)?$/u.exec(requestLine);
|
||||||
|
if (!request)
|
||||||
|
throw new SyntaxError(
|
||||||
|
"Saved request must begin with METHOD target HTTP/version",
|
||||||
|
);
|
||||||
|
const responseLine = responseSource.split("\n")[0] ?? "";
|
||||||
|
const response = /^HTTP\/\d(?:\.\d)?\s+(\d{3})/u.exec(responseLine);
|
||||||
|
const headerCount = (value: string) =>
|
||||||
|
value
|
||||||
|
.split("\n\n", 1)[0]!
|
||||||
|
.split("\n")
|
||||||
|
.slice(1)
|
||||||
|
.filter((line) => /^[^:\s]+:/u.test(line)).length;
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
method: request[1]!,
|
||||||
|
url: request[2]!,
|
||||||
|
status: response ? Number(response[1]) : undefined,
|
||||||
|
requestHeaders: headerCount(requestSource ?? ""),
|
||||||
|
responseHeaders: headerCount(responseSource),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -0,0 +1,246 @@
|
|||||||
|
import { stableStringify } from "@add-ideas/toolbox-helpers";
|
||||||
|
import { generateSchemaSample, resolveLocalReference } from "./refs";
|
||||||
|
import type {
|
||||||
|
ApiOperation,
|
||||||
|
JsonObject,
|
||||||
|
JsonValue,
|
||||||
|
LocalWorkspace,
|
||||||
|
} from "./types";
|
||||||
|
|
||||||
|
const METHODS = [
|
||||||
|
"get",
|
||||||
|
"put",
|
||||||
|
"post",
|
||||||
|
"delete",
|
||||||
|
"options",
|
||||||
|
"head",
|
||||||
|
"patch",
|
||||||
|
"trace",
|
||||||
|
] as const;
|
||||||
|
function asObject(value: JsonValue | undefined): JsonObject | undefined {
|
||||||
|
return value && typeof value === "object" && !Array.isArray(value)
|
||||||
|
? value
|
||||||
|
: undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function collectOperations(root: JsonObject): ApiOperation[] {
|
||||||
|
const paths = asObject(root.paths) ?? {};
|
||||||
|
const result: ApiOperation[] = [];
|
||||||
|
for (const [path, pathValue] of Object.entries(paths)) {
|
||||||
|
const pathItem = asObject(pathValue);
|
||||||
|
if (!pathItem || !path.startsWith("/")) continue;
|
||||||
|
const inheritedParameters = Array.isArray(pathItem.parameters)
|
||||||
|
? pathItem.parameters
|
||||||
|
: [];
|
||||||
|
for (const method of METHODS) {
|
||||||
|
const value = asObject(pathItem[method]);
|
||||||
|
if (!value) continue;
|
||||||
|
result.push({
|
||||||
|
key: `${method.toUpperCase()} ${path}`,
|
||||||
|
method: method.toUpperCase(),
|
||||||
|
path,
|
||||||
|
operationId:
|
||||||
|
typeof value.operationId === "string" ? value.operationId : undefined,
|
||||||
|
summary: typeof value.summary === "string" ? value.summary : undefined,
|
||||||
|
tags: Array.isArray(value.tags)
|
||||||
|
? value.tags.filter((tag): tag is string => typeof tag === "string")
|
||||||
|
: [],
|
||||||
|
value,
|
||||||
|
inheritedParameters,
|
||||||
|
});
|
||||||
|
if (result.length > 2_000)
|
||||||
|
throw new RangeError("Operation count exceeds 2,000");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
function dereferenceObject(
|
||||||
|
workspace: LocalWorkspace,
|
||||||
|
value: JsonValue,
|
||||||
|
from = workspace.entry,
|
||||||
|
): JsonObject | undefined {
|
||||||
|
const object = asObject(value);
|
||||||
|
if (!object) return undefined;
|
||||||
|
if (typeof object.$ref !== "string") return object;
|
||||||
|
const resolved = resolveLocalReference(workspace, object.$ref, from);
|
||||||
|
return asObject(resolved.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OperationExample {
|
||||||
|
url: string;
|
||||||
|
body?: JsonValue;
|
||||||
|
contentType?: string;
|
||||||
|
responseStatus?: string;
|
||||||
|
response?: JsonValue;
|
||||||
|
commands: { curl: string; fetch: string; python: string };
|
||||||
|
notices: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
function shellQuote(value: string): string {
|
||||||
|
return `'${value.replace(/'/gu, `'"'"'`)}'`;
|
||||||
|
}
|
||||||
|
function pythonQuote(value: string): string {
|
||||||
|
return JSON.stringify(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function operationExample(
|
||||||
|
workspace: LocalWorkspace,
|
||||||
|
operation: ApiOperation,
|
||||||
|
): OperationExample {
|
||||||
|
const root = workspace.documents.get(workspace.entry)!.value;
|
||||||
|
const notices: string[] = [];
|
||||||
|
const explainFailure = (context: string, reason: unknown) => {
|
||||||
|
notices.push(
|
||||||
|
`${context}: ${reason instanceof Error ? reason.message : "could not be resolved"}.`,
|
||||||
|
);
|
||||||
|
};
|
||||||
|
const resolveObject = (
|
||||||
|
value: JsonValue,
|
||||||
|
context: string,
|
||||||
|
): JsonObject | undefined => {
|
||||||
|
try {
|
||||||
|
return dereferenceObject(workspace, value);
|
||||||
|
} catch (reason) {
|
||||||
|
explainFailure(context, reason);
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const sampleSchema = (
|
||||||
|
schema: JsonValue,
|
||||||
|
context: string,
|
||||||
|
): { value: JsonValue } | undefined => {
|
||||||
|
try {
|
||||||
|
const result = generateSchemaSample(workspace, schema);
|
||||||
|
notices.push(...result.notices);
|
||||||
|
return { value: result.value };
|
||||||
|
} catch (reason) {
|
||||||
|
explainFailure(context, reason);
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
const server = Array.isArray(root.servers)
|
||||||
|
? asObject(root.servers[0])
|
||||||
|
: undefined;
|
||||||
|
const base =
|
||||||
|
typeof server?.url === "string" && !server.url.includes("{")
|
||||||
|
? server.url.replace(/\/$/u, "")
|
||||||
|
: "https://api.example.test";
|
||||||
|
if (base !== "https://api.example.test")
|
||||||
|
notices.push(
|
||||||
|
"The declared server URL is reproduced as inert text; it is not contacted.",
|
||||||
|
);
|
||||||
|
let path = operation.path;
|
||||||
|
const parameters = [
|
||||||
|
...operation.inheritedParameters,
|
||||||
|
...(Array.isArray(operation.value.parameters)
|
||||||
|
? operation.value.parameters
|
||||||
|
: []),
|
||||||
|
];
|
||||||
|
const queries: string[] = [];
|
||||||
|
for (const raw of parameters) {
|
||||||
|
const parameter = resolveObject(raw, "Parameter reference");
|
||||||
|
if (!parameter) continue;
|
||||||
|
const name =
|
||||||
|
typeof parameter.name === "string" ? parameter.name : "parameter";
|
||||||
|
const schema = parameter.schema ?? {};
|
||||||
|
const sample = sampleSchema(schema, `Parameter ${name}`);
|
||||||
|
if (!sample) continue;
|
||||||
|
const sampleText =
|
||||||
|
typeof sample.value === "string"
|
||||||
|
? sample.value
|
||||||
|
: sample.value !== null && typeof sample.value === "object"
|
||||||
|
? stableStringify(sample.value)
|
||||||
|
: String(sample.value);
|
||||||
|
const rendered = encodeURIComponent(sampleText);
|
||||||
|
if (parameter.in === "path") path = path.replace(`{${name}}`, rendered);
|
||||||
|
else if (parameter.in === "query")
|
||||||
|
queries.push(`${encodeURIComponent(name)}=${rendered}`);
|
||||||
|
}
|
||||||
|
const url = `${base}${path}${queries.length ? `?${queries.join("&")}` : ""}`;
|
||||||
|
const requestBody = resolveObject(
|
||||||
|
operation.value.requestBody ?? {},
|
||||||
|
"Request-body reference",
|
||||||
|
);
|
||||||
|
const content = asObject(requestBody?.content);
|
||||||
|
const contentType = content
|
||||||
|
? (Object.keys(content).find((type) => /json/iu.test(type)) ??
|
||||||
|
Object.keys(content)[0])
|
||||||
|
: undefined;
|
||||||
|
const media = contentType ? asObject(content![contentType]) : undefined;
|
||||||
|
const generatedBody = media?.schema
|
||||||
|
? sampleSchema(media.schema, "Request-body schema")
|
||||||
|
: undefined;
|
||||||
|
const body = generatedBody ? generatedBody.value : media?.example;
|
||||||
|
const responses = asObject(operation.value.responses) ?? {};
|
||||||
|
const responseStatus = Object.keys(responses).sort((a, b) =>
|
||||||
|
a === "default" ? 1 : b === "default" ? -1 : a.localeCompare(b),
|
||||||
|
)[0];
|
||||||
|
const responseObject = responseStatus
|
||||||
|
? resolveObject(responses[responseStatus]!, "Response reference")
|
||||||
|
: undefined;
|
||||||
|
const responseContent = asObject(responseObject?.content);
|
||||||
|
const responseType = responseContent
|
||||||
|
? (Object.keys(responseContent).find((type) => /json/iu.test(type)) ??
|
||||||
|
Object.keys(responseContent)[0])
|
||||||
|
: undefined;
|
||||||
|
const responseMedia = responseType
|
||||||
|
? asObject(responseContent![responseType])
|
||||||
|
: undefined;
|
||||||
|
const generatedResponse = responseMedia?.schema
|
||||||
|
? sampleSchema(responseMedia.schema, "Response schema")
|
||||||
|
: undefined;
|
||||||
|
const response = generatedResponse
|
||||||
|
? generatedResponse.value
|
||||||
|
: responseMedia?.example;
|
||||||
|
const bodyText = body === undefined ? undefined : stableStringify(body);
|
||||||
|
const curl = [
|
||||||
|
"curl",
|
||||||
|
"--request",
|
||||||
|
operation.method,
|
||||||
|
...(contentType
|
||||||
|
? ["--header", shellQuote(`Content-Type: ${contentType}`)]
|
||||||
|
: []),
|
||||||
|
...(bodyText ? ["--data", shellQuote(bodyText)] : []),
|
||||||
|
shellQuote(url),
|
||||||
|
].join(" ");
|
||||||
|
const fetchOptions = {
|
||||||
|
method: operation.method,
|
||||||
|
...(contentType ? { headers: { "Content-Type": contentType } } : {}),
|
||||||
|
...(bodyText ? { body: bodyText } : {}),
|
||||||
|
};
|
||||||
|
const fetch = `fetch(${JSON.stringify(url)}, ${stableStringify(fetchOptions, 2)});`;
|
||||||
|
const python = `requests.request(${pythonQuote(operation.method)}, ${pythonQuote(url)}${contentType ? `, headers={"Content-Type": ${pythonQuote(contentType)}}` : ""}${bodyText ? `, data=${pythonQuote(bodyText)}` : ""})`;
|
||||||
|
return {
|
||||||
|
url,
|
||||||
|
body,
|
||||||
|
contentType,
|
||||||
|
responseStatus,
|
||||||
|
response,
|
||||||
|
commands: { curl, fetch, python },
|
||||||
|
notices: [...new Set(notices)],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function securityInventory(
|
||||||
|
root: JsonObject,
|
||||||
|
): Array<{ name: string; type: string; detail: string }> {
|
||||||
|
const schemes = asObject(asObject(root.components)?.securitySchemes) ?? {};
|
||||||
|
return Object.entries(schemes)
|
||||||
|
.slice(0, 500)
|
||||||
|
.map(([name, raw]) => {
|
||||||
|
const scheme = asObject(raw) ?? {};
|
||||||
|
const type = typeof scheme.type === "string" ? scheme.type : "unknown";
|
||||||
|
const detail =
|
||||||
|
type === "apiKey"
|
||||||
|
? `${String(scheme.in ?? "?")} · ${String(scheme.name ?? "?")}`
|
||||||
|
: type === "http"
|
||||||
|
? String(scheme.scheme ?? "unspecified")
|
||||||
|
: type === "oauth2"
|
||||||
|
? `${Object.keys(asObject(scheme.flows) ?? {}).join(", ") || "no flows"}`
|
||||||
|
: type === "openIdConnect"
|
||||||
|
? "OpenID Connect URL retained as inert text"
|
||||||
|
: "No additional summary";
|
||||||
|
return { name, type, detail };
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,202 @@
|
|||||||
|
import { assertBoundedText, safeJsonParse } from "@add-ideas/toolbox-helpers";
|
||||||
|
import { parseDocument as parseYamlDocument } from "yaml";
|
||||||
|
import type {
|
||||||
|
ApiDocument,
|
||||||
|
JsonObject,
|
||||||
|
JsonValue,
|
||||||
|
ValidationProblem,
|
||||||
|
} from "./types";
|
||||||
|
|
||||||
|
const DANGEROUS_KEYS = new Set(["__proto__", "prototype", "constructor"]);
|
||||||
|
const MAX_SOURCE = 4 * 1024 * 1024;
|
||||||
|
const MAX_NODES = 100_000;
|
||||||
|
const MAX_DEPTH = 64;
|
||||||
|
|
||||||
|
function validateValue(
|
||||||
|
value: unknown,
|
||||||
|
path = "$",
|
||||||
|
depth = 0,
|
||||||
|
budget = { nodes: 0 },
|
||||||
|
): JsonValue {
|
||||||
|
budget.nodes += 1;
|
||||||
|
if (budget.nodes > MAX_NODES)
|
||||||
|
throw new RangeError(`Document exceeds ${MAX_NODES} values`);
|
||||||
|
if (depth > MAX_DEPTH)
|
||||||
|
throw new RangeError(`Document nesting exceeds ${MAX_DEPTH}`);
|
||||||
|
if (value === null || typeof value === "string" || typeof value === "boolean")
|
||||||
|
return value;
|
||||||
|
if (typeof value === "number") {
|
||||||
|
if (!Number.isFinite(value))
|
||||||
|
throw new TypeError(`${path} contains a non-finite number`);
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
if (Array.isArray(value))
|
||||||
|
return value.map((item, index) =>
|
||||||
|
validateValue(item, `${path}/${index}`, depth + 1, budget),
|
||||||
|
);
|
||||||
|
if (typeof value !== "object")
|
||||||
|
throw new TypeError(`${path} contains a non-JSON value`);
|
||||||
|
const prototype = Object.getPrototypeOf(value) as unknown;
|
||||||
|
if (prototype !== Object.prototype && prototype !== null)
|
||||||
|
throw new TypeError(`${path} is not a plain object`);
|
||||||
|
const output: JsonObject = Object.create(null) as JsonObject;
|
||||||
|
for (const [key, child] of Object.entries(value)) {
|
||||||
|
if (DANGEROUS_KEYS.has(key))
|
||||||
|
throw new TypeError(`${path} contains prohibited key “${key}”`);
|
||||||
|
output[key] = validateValue(child, `${path}/${key}`, depth + 1, budget);
|
||||||
|
}
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function parseApiDocument(
|
||||||
|
source: string,
|
||||||
|
filename = "openapi.yaml",
|
||||||
|
): ApiDocument {
|
||||||
|
const text = assertBoundedText(source, MAX_SOURCE, "API description length");
|
||||||
|
if (text.includes("\0"))
|
||||||
|
throw new SyntaxError("Description contains NUL bytes");
|
||||||
|
const jsonLike = /^\s*[{[]/u.test(text);
|
||||||
|
let value: unknown;
|
||||||
|
let format: "json" | "yaml";
|
||||||
|
if (jsonLike) {
|
||||||
|
value = safeJsonParse(text, {
|
||||||
|
maxTextChars: MAX_SOURCE,
|
||||||
|
maxDepth: MAX_DEPTH,
|
||||||
|
maxNodes: MAX_NODES,
|
||||||
|
rejectDangerousKeys: true,
|
||||||
|
});
|
||||||
|
format = "json";
|
||||||
|
} else {
|
||||||
|
const document = parseYamlDocument(text, {
|
||||||
|
uniqueKeys: true,
|
||||||
|
merge: false,
|
||||||
|
});
|
||||||
|
if (document.errors.length)
|
||||||
|
throw new SyntaxError(
|
||||||
|
`Invalid YAML: ${document.errors.map((error) => error.message).join("; ")}`,
|
||||||
|
);
|
||||||
|
value = document.toJS({ maxAliasCount: 50, mapAsMap: false });
|
||||||
|
format = "yaml";
|
||||||
|
}
|
||||||
|
const validated = validateValue(value);
|
||||||
|
if (!validated || Array.isArray(validated) || typeof validated !== "object")
|
||||||
|
throw new TypeError("API description must be an object");
|
||||||
|
return {
|
||||||
|
filename: normalizeFilename(filename),
|
||||||
|
format,
|
||||||
|
value: validated,
|
||||||
|
source: text,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function normalizeFilename(input: string): string {
|
||||||
|
const normalized = input
|
||||||
|
.replace(/\\/gu, "/")
|
||||||
|
.replace(/^\.\//u, "")
|
||||||
|
.replace(/\/+/gu, "/");
|
||||||
|
if (
|
||||||
|
!normalized ||
|
||||||
|
normalized.startsWith("/") ||
|
||||||
|
normalized.split("/").includes("..")
|
||||||
|
)
|
||||||
|
throw new TypeError(
|
||||||
|
"Local API filenames must be relative and may not traverse parent directories",
|
||||||
|
);
|
||||||
|
return normalized;
|
||||||
|
}
|
||||||
|
|
||||||
|
function object(value: JsonValue | undefined): JsonObject | undefined {
|
||||||
|
return value && typeof value === "object" && !Array.isArray(value)
|
||||||
|
? value
|
||||||
|
: undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function validateOpenApi(document: ApiDocument): ValidationProblem[] {
|
||||||
|
const root = document.value;
|
||||||
|
const problems: ValidationProblem[] = [];
|
||||||
|
const version = typeof root.openapi === "string" ? root.openapi : undefined;
|
||||||
|
if (!version)
|
||||||
|
problems.push({
|
||||||
|
level: "error",
|
||||||
|
path: "/openapi",
|
||||||
|
message: "Missing OpenAPI version string.",
|
||||||
|
});
|
||||||
|
else if (!/^3\.(?:0|1)\.\d+(?:[-+].*)?$/u.test(version))
|
||||||
|
problems.push({
|
||||||
|
level: "error",
|
||||||
|
path: "/openapi",
|
||||||
|
message: `Version “${version}” is outside the supported OpenAPI 3.0/3.1 families.`,
|
||||||
|
});
|
||||||
|
const info = object(root.info);
|
||||||
|
if (!info)
|
||||||
|
problems.push({
|
||||||
|
level: "error",
|
||||||
|
path: "/info",
|
||||||
|
message: "Missing info object.",
|
||||||
|
});
|
||||||
|
else {
|
||||||
|
if (typeof info.title !== "string" || !info.title.trim())
|
||||||
|
problems.push({
|
||||||
|
level: "error",
|
||||||
|
path: "/info/title",
|
||||||
|
message: "A non-empty API title is required.",
|
||||||
|
});
|
||||||
|
if (typeof info.version !== "string" || !info.version.trim())
|
||||||
|
problems.push({
|
||||||
|
level: "error",
|
||||||
|
path: "/info/version",
|
||||||
|
message: "A non-empty API version is required.",
|
||||||
|
});
|
||||||
|
}
|
||||||
|
const paths = object(root.paths);
|
||||||
|
if (!paths)
|
||||||
|
problems.push({
|
||||||
|
level: "error",
|
||||||
|
path: "/paths",
|
||||||
|
message: "Missing paths object.",
|
||||||
|
});
|
||||||
|
else if (Object.keys(paths).length === 0)
|
||||||
|
problems.push({
|
||||||
|
level: "warning",
|
||||||
|
path: "/paths",
|
||||||
|
message: "No paths are declared.",
|
||||||
|
});
|
||||||
|
if (root.swagger !== undefined)
|
||||||
|
problems.push({
|
||||||
|
level: "warning",
|
||||||
|
path: "/swagger",
|
||||||
|
message: "Swagger 2.0 fields are not interpreted by this OpenAPI 3 tool.",
|
||||||
|
});
|
||||||
|
const refs: string[] = [];
|
||||||
|
const visit = (value: JsonValue, path: string, depth: number) => {
|
||||||
|
if (depth > 64) return;
|
||||||
|
if (Array.isArray(value))
|
||||||
|
value.forEach((item, index) =>
|
||||||
|
visit(item, `${path}/${index}`, depth + 1),
|
||||||
|
);
|
||||||
|
else if (value && typeof value === "object")
|
||||||
|
for (const [key, child] of Object.entries(value)) {
|
||||||
|
if (key === "$ref" && typeof child === "string") refs.push(child);
|
||||||
|
else visit(child, `${path}/${key}`, depth + 1);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
visit(root, "", 0);
|
||||||
|
for (const ref of refs)
|
||||||
|
if (
|
||||||
|
/^[a-z][a-z0-9+.-]*:/iu.test(ref) ||
|
||||||
|
ref.startsWith("//") ||
|
||||||
|
ref.startsWith("/")
|
||||||
|
)
|
||||||
|
problems.push({
|
||||||
|
level: "error",
|
||||||
|
path: "/$ref",
|
||||||
|
message: `Remote or absolute reference is prohibited: ${ref}`,
|
||||||
|
});
|
||||||
|
if (!problems.some((problem) => problem.level === "error"))
|
||||||
|
problems.unshift({
|
||||||
|
level: "info",
|
||||||
|
path: "/",
|
||||||
|
message: `Focused structural checks passed for OpenAPI ${version}.`,
|
||||||
|
});
|
||||||
|
return problems.slice(0, 1_000);
|
||||||
|
}
|
||||||
@@ -0,0 +1,202 @@
|
|||||||
|
import type {
|
||||||
|
ApiDocument,
|
||||||
|
JsonObject,
|
||||||
|
JsonValue,
|
||||||
|
LocalWorkspace,
|
||||||
|
} from "./types";
|
||||||
|
import { normalizeFilename } from "./parse";
|
||||||
|
|
||||||
|
function parentDirectory(filename: string): string {
|
||||||
|
const index = filename.lastIndexOf("/");
|
||||||
|
return index < 0 ? "" : filename.slice(0, index + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
function normalizeRelative(base: string, relative: string): string {
|
||||||
|
const segments = `${parentDirectory(base)}${relative}`.split("/");
|
||||||
|
const output: string[] = [];
|
||||||
|
for (const segment of segments) {
|
||||||
|
if (!segment || segment === ".") continue;
|
||||||
|
if (segment === "..") {
|
||||||
|
if (!output.length)
|
||||||
|
throw new TypeError("Reference escapes the local workspace");
|
||||||
|
output.pop();
|
||||||
|
} else output.push(segment);
|
||||||
|
}
|
||||||
|
return normalizeFilename(output.join("/"));
|
||||||
|
}
|
||||||
|
|
||||||
|
function pointerValue(value: JsonValue, fragment: string): JsonValue {
|
||||||
|
if (!fragment || fragment === "#") return value;
|
||||||
|
if (!fragment.startsWith("#/"))
|
||||||
|
throw new SyntaxError(
|
||||||
|
`Only JSON Pointer fragments are supported: ${fragment}`,
|
||||||
|
);
|
||||||
|
let current: JsonValue = value;
|
||||||
|
for (const raw of fragment.slice(2).split("/")) {
|
||||||
|
const token = decodeURIComponent(raw)
|
||||||
|
.replace(/~1/gu, "/")
|
||||||
|
.replace(/~0/gu, "~");
|
||||||
|
if (Array.isArray(current)) {
|
||||||
|
if (!/^(?:0|[1-9]\d*)$/u.test(token) || Number(token) >= current.length)
|
||||||
|
throw new ReferenceError(`Array reference token not found: ${token}`);
|
||||||
|
current = current[Number(token)]!;
|
||||||
|
} else if (
|
||||||
|
current &&
|
||||||
|
typeof current === "object" &&
|
||||||
|
Object.hasOwn(current, token)
|
||||||
|
)
|
||||||
|
current = current[token]!;
|
||||||
|
else throw new ReferenceError(`Reference token not found: ${token}`);
|
||||||
|
}
|
||||||
|
return current;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createWorkspace(
|
||||||
|
entry: ApiDocument,
|
||||||
|
supporting: readonly ApiDocument[] = [],
|
||||||
|
): LocalWorkspace {
|
||||||
|
const documents = new Map<string, ApiDocument>();
|
||||||
|
for (const document of [entry, ...supporting]) {
|
||||||
|
if (documents.has(document.filename))
|
||||||
|
throw new TypeError(`Duplicate local filename: ${document.filename}`);
|
||||||
|
documents.set(document.filename, document);
|
||||||
|
}
|
||||||
|
return { entry: entry.filename, documents };
|
||||||
|
}
|
||||||
|
|
||||||
|
export function resolveLocalReference(
|
||||||
|
workspace: LocalWorkspace,
|
||||||
|
reference: string,
|
||||||
|
from = workspace.entry,
|
||||||
|
): { document: ApiDocument; value: JsonValue; key: string } {
|
||||||
|
if (
|
||||||
|
/^[a-z][a-z0-9+.-]*:/iu.test(reference) ||
|
||||||
|
reference.startsWith("//") ||
|
||||||
|
reference.startsWith("/")
|
||||||
|
)
|
||||||
|
throw new TypeError(
|
||||||
|
`Remote or absolute references are disabled: ${reference}`,
|
||||||
|
);
|
||||||
|
const hash = reference.indexOf("#");
|
||||||
|
const filePart = hash < 0 ? reference : reference.slice(0, hash);
|
||||||
|
const fragment = hash < 0 ? "" : reference.slice(hash);
|
||||||
|
const filename = filePart ? normalizeRelative(from, filePart) : from;
|
||||||
|
const document = workspace.documents.get(filename);
|
||||||
|
if (!document)
|
||||||
|
throw new ReferenceError(
|
||||||
|
`Local reference file was not supplied: ${filename}`,
|
||||||
|
);
|
||||||
|
return {
|
||||||
|
document,
|
||||||
|
value: pointerValue(document.value, fragment),
|
||||||
|
key: `${filename}${fragment}`,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function asObject(value: JsonValue | undefined): JsonObject | undefined {
|
||||||
|
return value && typeof value === "object" && !Array.isArray(value)
|
||||||
|
? value
|
||||||
|
: undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SampleResult {
|
||||||
|
value: JsonValue;
|
||||||
|
notices: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function generateSchemaSample(
|
||||||
|
workspace: LocalWorkspace,
|
||||||
|
schema: JsonValue,
|
||||||
|
from = workspace.entry,
|
||||||
|
): SampleResult {
|
||||||
|
const notices: string[] = [];
|
||||||
|
const active = new Set<string>();
|
||||||
|
let nodes = 0;
|
||||||
|
const build = (
|
||||||
|
value: JsonValue,
|
||||||
|
filename: string,
|
||||||
|
depth: number,
|
||||||
|
): JsonValue => {
|
||||||
|
nodes += 1;
|
||||||
|
if (nodes > 2_000 || depth > 20) {
|
||||||
|
notices.push(
|
||||||
|
"Sample generation reached its bounded depth or node limit.",
|
||||||
|
);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
const object = asObject(value);
|
||||||
|
if (!object) return value;
|
||||||
|
if (typeof object.$ref === "string") {
|
||||||
|
const resolved = resolveLocalReference(workspace, object.$ref, filename);
|
||||||
|
if (active.has(resolved.key)) {
|
||||||
|
notices.push(`Reference cycle stopped at ${resolved.key}.`);
|
||||||
|
return { $cycle: resolved.key };
|
||||||
|
}
|
||||||
|
active.add(resolved.key);
|
||||||
|
try {
|
||||||
|
return build(resolved.value, resolved.document.filename, depth + 1);
|
||||||
|
} finally {
|
||||||
|
active.delete(resolved.key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (const key of ["example", "default"] as const)
|
||||||
|
if (object[key] !== undefined) return object[key]!;
|
||||||
|
if (Array.isArray(object.enum) && object.enum.length)
|
||||||
|
return object.enum[0]!;
|
||||||
|
if (Array.isArray(object.allOf)) {
|
||||||
|
const merged: JsonObject = Object.create(null) as JsonObject;
|
||||||
|
for (const child of object.allOf) {
|
||||||
|
const sample = build(child, filename, depth + 1);
|
||||||
|
if (asObject(sample)) Object.assign(merged, sample);
|
||||||
|
else notices.push("A non-object allOf sample could not be merged.");
|
||||||
|
}
|
||||||
|
return merged;
|
||||||
|
}
|
||||||
|
for (const key of ["oneOf", "anyOf"] as const)
|
||||||
|
if (Array.isArray(object[key]) && object[key]!.length) {
|
||||||
|
notices.push(`${key} uses the first alternative.`);
|
||||||
|
return build(object[key]![0]!, filename, depth + 1);
|
||||||
|
}
|
||||||
|
const type =
|
||||||
|
typeof object.type === "string"
|
||||||
|
? object.type
|
||||||
|
: object.properties
|
||||||
|
? "object"
|
||||||
|
: object.items
|
||||||
|
? "array"
|
||||||
|
: undefined;
|
||||||
|
if (type === "object") {
|
||||||
|
const output: JsonObject = Object.create(null) as JsonObject;
|
||||||
|
const properties = asObject(object.properties) ?? {};
|
||||||
|
for (const [key, child] of Object.entries(properties).slice(0, 100))
|
||||||
|
output[key] = build(child, filename, depth + 1);
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
if (type === "array")
|
||||||
|
return object.items ? [build(object.items, filename, depth + 1)] : [];
|
||||||
|
if (type === "integer" || type === "number")
|
||||||
|
return typeof object.minimum === "number" ? object.minimum : 0;
|
||||||
|
if (type === "boolean") return true;
|
||||||
|
if (type === "null") return null;
|
||||||
|
const format = typeof object.format === "string" ? object.format : "";
|
||||||
|
return (
|
||||||
|
(
|
||||||
|
{
|
||||||
|
date: "2026-09-01",
|
||||||
|
"date-time": "2026-09-01T12:00:00Z",
|
||||||
|
email: "user@example.test",
|
||||||
|
uuid: "00000000-0000-4000-8000-000000000000",
|
||||||
|
uri: "https://example.test/resource",
|
||||||
|
hostname: "example.test",
|
||||||
|
ipv4: "192.0.2.1",
|
||||||
|
ipv6: "2001:db8::1",
|
||||||
|
binary: "<binary>",
|
||||||
|
} as Record<string, string>
|
||||||
|
)[format] ??
|
||||||
|
(typeof object.pattern === "string"
|
||||||
|
? `<string matching ${object.pattern}>`
|
||||||
|
: "string")
|
||||||
|
);
|
||||||
|
};
|
||||||
|
return { value: build(schema, from, 0), notices: [...new Set(notices)] };
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
export type JsonPrimitive = null | boolean | number | string;
|
||||||
|
export type JsonValue = JsonPrimitive | JsonValue[] | JsonObject;
|
||||||
|
export interface JsonObject {
|
||||||
|
[key: string]: JsonValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ApiDocument {
|
||||||
|
filename: string;
|
||||||
|
format: "json" | "yaml";
|
||||||
|
value: JsonObject;
|
||||||
|
source: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ValidationProblem {
|
||||||
|
level: "error" | "warning" | "info";
|
||||||
|
path: string;
|
||||||
|
message: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ApiOperation {
|
||||||
|
key: string;
|
||||||
|
method: string;
|
||||||
|
path: string;
|
||||||
|
operationId?: string;
|
||||||
|
summary?: string;
|
||||||
|
tags: string[];
|
||||||
|
value: JsonObject;
|
||||||
|
inheritedParameters: JsonValue[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LocalWorkspace {
|
||||||
|
entry: string;
|
||||||
|
documents: Map<string, ApiDocument>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
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);
|
||||||
|
});
|
||||||
|
}
|
||||||
+621
@@ -0,0 +1,621 @@
|
|||||||
|
: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;
|
||||||
|
--mail-success: #11715c;
|
||||||
|
--mail-warning: #8a5508;
|
||||||
|
}
|
||||||
|
* {
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
#root {
|
||||||
|
min-height: 100vh;
|
||||||
|
}
|
||||||
|
.toolbox-shell__main {
|
||||||
|
width: min(100%, 90rem);
|
||||||
|
padding: clamp(0.75rem, 1.8vw, 1.5rem);
|
||||||
|
}
|
||||||
|
.workbench {
|
||||||
|
display: grid;
|
||||||
|
gap: 1rem;
|
||||||
|
}
|
||||||
|
.workbench :where(h1, h2, h3),
|
||||||
|
.help-dialog h2,
|
||||||
|
.fatal h1 {
|
||||||
|
margin: 0;
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
line-height: 1.18;
|
||||||
|
letter-spacing: -0.025em;
|
||||||
|
}
|
||||||
|
.workbench h1 {
|
||||||
|
font-size: clamp(1.75rem, 3vw, 2.55rem);
|
||||||
|
}
|
||||||
|
.workbench h2,
|
||||||
|
.help-dialog h2 {
|
||||||
|
font-size: clamp(1.15rem, 2vw, 1.5rem);
|
||||||
|
}
|
||||||
|
.workbench h3 {
|
||||||
|
font-size: 0.96rem;
|
||||||
|
}
|
||||||
|
.workbench :where(p, ul) {
|
||||||
|
margin-block: 0;
|
||||||
|
}
|
||||||
|
.workbench :where(button, input, select, textarea),
|
||||||
|
.help-dialog button {
|
||||||
|
font: inherit;
|
||||||
|
}
|
||||||
|
.workbench button,
|
||||||
|
.workbench .button,
|
||||||
|
.help-dialog 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.64rem;
|
||||||
|
background: var(--toolbox-surface);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
font-size: 0.82rem;
|
||||||
|
font-weight: 720;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
.workbench button:hover,
|
||||||
|
.workbench .button:hover {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
.workbench .primary-button {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-accent);
|
||||||
|
color: var(--toolbox-accent-contrast);
|
||||||
|
}
|
||||||
|
:where(.workbench, .help-dialog)
|
||||||
|
:where(button, input, select, textarea):focus-visible,
|
||||||
|
.table-scroll:focus-visible {
|
||||||
|
outline: 3px solid color-mix(in srgb, var(--toolbox-focus) 42%, transparent);
|
||||||
|
outline-offset: 2px;
|
||||||
|
}
|
||||||
|
.workbench :where(select, textarea) {
|
||||||
|
width: 100%;
|
||||||
|
min-width: 0;
|
||||||
|
padding: 0.62rem 0.7rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.62rem;
|
||||||
|
background: var(--toolbox-surface);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
line-height: 1.4;
|
||||||
|
}
|
||||||
|
.workbench textarea {
|
||||||
|
resize: vertical;
|
||||||
|
font:
|
||||||
|
0.82rem/1.45 ui-monospace,
|
||||||
|
SFMono-Regular,
|
||||||
|
Consolas,
|
||||||
|
monospace;
|
||||||
|
tab-size: 2;
|
||||||
|
}
|
||||||
|
.hero,
|
||||||
|
.panel {
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.84rem;
|
||||||
|
background: var(--toolbox-surface);
|
||||||
|
box-shadow:
|
||||||
|
0 1px 2px rgb(24 31 65 / 4%),
|
||||||
|
0 10px 30px rgb(24 31 65 / 3%);
|
||||||
|
}
|
||||||
|
.hero {
|
||||||
|
display: flex;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1rem;
|
||||||
|
padding: clamp(1.1rem, 3vw, 2rem);
|
||||||
|
}
|
||||||
|
.hero p:not(.eyebrow) {
|
||||||
|
max-width: 55rem;
|
||||||
|
margin-top: 0.55rem;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
line-height: 1.55;
|
||||||
|
}
|
||||||
|
.eyebrow {
|
||||||
|
margin: 0 0 0.3rem !important;
|
||||||
|
color: var(--toolbox-accent);
|
||||||
|
font-size: 0.68rem;
|
||||||
|
font-weight: 820;
|
||||||
|
letter-spacing: 0.115em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
}
|
||||||
|
.privacy-pill,
|
||||||
|
.count-pill {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
align-self: flex-start;
|
||||||
|
padding: 0.38rem 0.64rem;
|
||||||
|
border-radius: 999px;
|
||||||
|
background: var(--toolbox-accent-soft);
|
||||||
|
color: var(--toolbox-accent);
|
||||||
|
font-size: 0.75rem;
|
||||||
|
font-weight: 780;
|
||||||
|
}
|
||||||
|
.panel {
|
||||||
|
min-width: 0;
|
||||||
|
padding: clamp(0.9rem, 2vw, 1.2rem);
|
||||||
|
}
|
||||||
|
.panel-heading {
|
||||||
|
display: flex;
|
||||||
|
align-items: flex-end;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1rem;
|
||||||
|
margin-bottom: 0.8rem;
|
||||||
|
}
|
||||||
|
.panel-heading p,
|
||||||
|
.muted,
|
||||||
|
.panel > p {
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.8rem;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
.file-button input {
|
||||||
|
position: absolute;
|
||||||
|
width: 1px;
|
||||||
|
height: 1px;
|
||||||
|
overflow: hidden;
|
||||||
|
clip: rect(0 0 0 0);
|
||||||
|
}
|
||||||
|
.entry-select {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: auto minmax(10rem, 1fr);
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.45rem;
|
||||||
|
margin-top: 0.45rem;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.72rem;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.entry-select select {
|
||||||
|
min-height: 2.1rem;
|
||||||
|
padding-block: 0.35rem;
|
||||||
|
}
|
||||||
|
.action-row {
|
||||||
|
display: flex;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.6rem;
|
||||||
|
margin-top: 0.75rem;
|
||||||
|
}
|
||||||
|
.success,
|
||||||
|
.error,
|
||||||
|
.warning {
|
||||||
|
margin-top: 0.65rem !important;
|
||||||
|
padding: 0.55rem 0.65rem;
|
||||||
|
border-radius: 0.55rem;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
}
|
||||||
|
.success {
|
||||||
|
color: var(--mail-success);
|
||||||
|
background: color-mix(in srgb, var(--mail-success) 10%, transparent);
|
||||||
|
}
|
||||||
|
.error {
|
||||||
|
color: var(--toolbox-danger);
|
||||||
|
background: color-mix(in srgb, var(--toolbox-danger) 10%, transparent);
|
||||||
|
}
|
||||||
|
.warning {
|
||||||
|
color: var(--mail-warning);
|
||||||
|
background: color-mix(in srgb, var(--mail-warning) 10%, transparent);
|
||||||
|
}
|
||||||
|
.tabs {
|
||||||
|
display: flex;
|
||||||
|
gap: 0.4rem;
|
||||||
|
overflow-x: auto;
|
||||||
|
padding: 0.15rem;
|
||||||
|
}
|
||||||
|
.tabs button[aria-pressed="true"] {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-accent-soft);
|
||||||
|
color: var(--toolbox-accent);
|
||||||
|
}
|
||||||
|
.workspace-grid,
|
||||||
|
.body-grid,
|
||||||
|
.selector-grid {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(2, minmax(0, 1fr));
|
||||||
|
gap: 1rem;
|
||||||
|
}
|
||||||
|
.selector-grid {
|
||||||
|
margin-bottom: 0.8rem;
|
||||||
|
}
|
||||||
|
.selector-grid label {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.35rem;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.75rem;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.workbench input.search {
|
||||||
|
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);
|
||||||
|
}
|
||||||
|
.operation-workspace {
|
||||||
|
grid-template-columns: minmax(17rem, 0.72fr) minmax(0, 1.5fr);
|
||||||
|
}
|
||||||
|
.operation-list {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.35rem;
|
||||||
|
max-height: 48rem;
|
||||||
|
margin-top: 0.7rem !important;
|
||||||
|
padding: 0;
|
||||||
|
overflow: auto;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
.operation-list button {
|
||||||
|
width: 100%;
|
||||||
|
justify-content: flex-start;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
.operation-list button[aria-pressed="true"] {
|
||||||
|
border-color: var(--toolbox-accent);
|
||||||
|
background: var(--toolbox-accent-soft);
|
||||||
|
}
|
||||||
|
.operation-list button > span:last-child {
|
||||||
|
display: grid;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
.operation-list small {
|
||||||
|
overflow: hidden;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-weight: 500;
|
||||||
|
text-overflow: ellipsis;
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
.method {
|
||||||
|
min-width: 3.8rem;
|
||||||
|
padding: 0.25rem 0.35rem;
|
||||||
|
border-radius: 0.35rem;
|
||||||
|
background: var(--toolbox-accent-soft);
|
||||||
|
color: var(--toolbox-accent);
|
||||||
|
font:
|
||||||
|
750 0.66rem ui-monospace,
|
||||||
|
monospace;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.method-post,
|
||||||
|
.method-patch {
|
||||||
|
color: #815000;
|
||||||
|
background: #fff1ce;
|
||||||
|
}
|
||||||
|
.method-delete {
|
||||||
|
color: var(--toolbox-danger);
|
||||||
|
background: color-mix(in srgb, var(--toolbox-danger) 10%, transparent);
|
||||||
|
}
|
||||||
|
.operation-detail {
|
||||||
|
display: grid;
|
||||||
|
align-content: start;
|
||||||
|
gap: 0.65rem;
|
||||||
|
}
|
||||||
|
.operation-detail label {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.3rem;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.75rem;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.operation-detail pre {
|
||||||
|
max-height: 20rem;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0.75rem;
|
||||||
|
overflow: auto;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.6rem;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
white-space: pre-wrap;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
font:
|
||||||
|
0.78rem/1.45 ui-monospace,
|
||||||
|
SFMono-Regular,
|
||||||
|
Consolas,
|
||||||
|
monospace;
|
||||||
|
}
|
||||||
|
.facts {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: repeat(3, minmax(0, 1fr));
|
||||||
|
gap: 0.55rem;
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
.facts > div {
|
||||||
|
min-width: 0;
|
||||||
|
padding: 0.6rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.55rem;
|
||||||
|
}
|
||||||
|
.facts dt {
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.68rem;
|
||||||
|
font-weight: 750;
|
||||||
|
text-transform: uppercase;
|
||||||
|
}
|
||||||
|
.facts dd {
|
||||||
|
margin: 0.25rem 0 0;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
}
|
||||||
|
.part-tree,
|
||||||
|
.part-tree ul {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.35rem;
|
||||||
|
padding-left: 1.15rem;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
.part-tree {
|
||||||
|
padding-left: 0;
|
||||||
|
}
|
||||||
|
.part-tree li {
|
||||||
|
position: relative;
|
||||||
|
min-width: 0;
|
||||||
|
padding: 0.45rem 0.55rem;
|
||||||
|
border-left: 2px solid var(--toolbox-border);
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
border-radius: 0.35rem;
|
||||||
|
}
|
||||||
|
.part-label {
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
}
|
||||||
|
.part-label small,
|
||||||
|
.filename {
|
||||||
|
margin-left: 0.4rem;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.72rem;
|
||||||
|
}
|
||||||
|
.filename {
|
||||||
|
display: block;
|
||||||
|
margin: 0.25rem 0 0;
|
||||||
|
}
|
||||||
|
.table-scroll {
|
||||||
|
max-height: 31rem;
|
||||||
|
overflow: auto;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.6rem;
|
||||||
|
}
|
||||||
|
table {
|
||||||
|
width: 100%;
|
||||||
|
border-collapse: collapse;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
}
|
||||||
|
th,
|
||||||
|
td {
|
||||||
|
padding: 0.55rem 0.62rem;
|
||||||
|
border-bottom: 1px solid var(--toolbox-border);
|
||||||
|
text-align: left;
|
||||||
|
vertical-align: top;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
}
|
||||||
|
thead th {
|
||||||
|
position: sticky;
|
||||||
|
top: 0;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
tbody th {
|
||||||
|
width: 9rem;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
}
|
||||||
|
.comparison-summary {
|
||||||
|
margin-bottom: 0.8rem !important;
|
||||||
|
color: var(--mail-warning);
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
.body-grid > div {
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
.body-preview,
|
||||||
|
.diff-preview,
|
||||||
|
.report-preview,
|
||||||
|
iframe {
|
||||||
|
width: 100%;
|
||||||
|
min-height: 21rem;
|
||||||
|
max-height: 36rem;
|
||||||
|
margin: 0.45rem 0 0;
|
||||||
|
overflow: auto;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.6rem;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
color: var(--toolbox-text);
|
||||||
|
padding: 0.75rem;
|
||||||
|
white-space: pre-wrap;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
font:
|
||||||
|
0.78rem/1.45 ui-monospace,
|
||||||
|
SFMono-Regular,
|
||||||
|
Consolas,
|
||||||
|
monospace;
|
||||||
|
}
|
||||||
|
iframe {
|
||||||
|
padding: 0;
|
||||||
|
background: #fff;
|
||||||
|
}
|
||||||
|
.diff-added {
|
||||||
|
color: #11715c;
|
||||||
|
background: color-mix(in srgb, #11715c 11%, transparent);
|
||||||
|
}
|
||||||
|
.diff-removed {
|
||||||
|
color: var(--toolbox-danger);
|
||||||
|
background: color-mix(in srgb, var(--toolbox-danger) 10%, transparent);
|
||||||
|
}
|
||||||
|
.cards,
|
||||||
|
.diagnostic-list {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.6rem;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
.cards li {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: minmax(0, 1fr) auto;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.25rem 0.8rem;
|
||||||
|
padding: 0.7rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.65rem;
|
||||||
|
}
|
||||||
|
.cards p,
|
||||||
|
.diagnostic-list p {
|
||||||
|
margin-top: 0.25rem;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.76rem;
|
||||||
|
overflow-wrap: anywhere;
|
||||||
|
}
|
||||||
|
.cards p {
|
||||||
|
grid-column: 1 / -1;
|
||||||
|
}
|
||||||
|
.diagnostic-list li {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: 9rem minmax(0, 1fr);
|
||||||
|
gap: 0.3rem 0.7rem;
|
||||||
|
padding: 0.65rem;
|
||||||
|
border-left: 3px solid var(--mail-success);
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
.diagnostic-list li.warning {
|
||||||
|
border-left-color: var(--mail-warning);
|
||||||
|
}
|
||||||
|
.diagnostic-list code {
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.7rem;
|
||||||
|
}
|
||||||
|
.diagnostic-list p {
|
||||||
|
grid-column: 2;
|
||||||
|
}
|
||||||
|
.empty {
|
||||||
|
padding: 1rem;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
.change-list {
|
||||||
|
display: grid;
|
||||||
|
gap: 0.55rem;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
.change-list li {
|
||||||
|
display: grid;
|
||||||
|
grid-template-columns: 7rem minmax(0, 1fr);
|
||||||
|
gap: 0.25rem 0.6rem;
|
||||||
|
padding: 0.65rem;
|
||||||
|
border-left: 3px solid var(--mail-warning);
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
}
|
||||||
|
.change-list li.breaking {
|
||||||
|
border-left-color: var(--toolbox-danger);
|
||||||
|
}
|
||||||
|
.change-list li.non-breaking {
|
||||||
|
border-left-color: var(--mail-success);
|
||||||
|
}
|
||||||
|
.change-list li > strong {
|
||||||
|
font-size: 0.68rem;
|
||||||
|
text-transform: uppercase;
|
||||||
|
}
|
||||||
|
.change-list p {
|
||||||
|
grid-column: 2;
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.78rem;
|
||||||
|
}
|
||||||
|
.disclosure {
|
||||||
|
margin-top: 0.75rem !important;
|
||||||
|
padding: 0.75rem;
|
||||||
|
border: 1px solid var(--toolbox-border);
|
||||||
|
border-radius: 0.65rem;
|
||||||
|
background: var(--toolbox-surface-soft);
|
||||||
|
color: var(--toolbox-muted);
|
||||||
|
font-size: 0.8rem;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
.top-gap {
|
||||||
|
margin-top: 0.7rem;
|
||||||
|
}
|
||||||
|
.report-preview {
|
||||||
|
min-height: 12rem;
|
||||||
|
}
|
||||||
|
.loading,
|
||||||
|
.fatal {
|
||||||
|
width: min(100% - 2rem, 60rem);
|
||||||
|
margin: 2rem auto;
|
||||||
|
padding: 1rem;
|
||||||
|
}
|
||||||
|
.help-dialog {
|
||||||
|
width: min(38rem, 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;
|
||||||
|
align-items: start;
|
||||||
|
justify-content: space-between;
|
||||||
|
gap: 1rem;
|
||||||
|
}
|
||||||
|
.help-dialog p {
|
||||||
|
line-height: 1.55;
|
||||||
|
}
|
||||||
|
@media (max-width: 60rem) {
|
||||||
|
.workspace-grid,
|
||||||
|
.body-grid,
|
||||||
|
.operation-workspace {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media (max-width: 40rem) {
|
||||||
|
.hero,
|
||||||
|
.panel-heading {
|
||||||
|
flex-direction: column;
|
||||||
|
align-items: flex-start;
|
||||||
|
}
|
||||||
|
.selector-grid,
|
||||||
|
.facts {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
.diagnostic-list li,
|
||||||
|
.change-list li {
|
||||||
|
grid-template-columns: 1fr;
|
||||||
|
}
|
||||||
|
.diagnostic-list p,
|
||||||
|
.change-list p {
|
||||||
|
grid-column: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media (prefers-reduced-motion: reduce) {
|
||||||
|
*,
|
||||||
|
*::before,
|
||||||
|
*::after {
|
||||||
|
transition-duration: 0.01ms !important;
|
||||||
|
animation-duration: 0.01ms !important;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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.api-tools",
|
||||||
|
"name": "API Tools",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "Inspect and compare API descriptions locally.",
|
||||||
|
"entry": "./",
|
||||||
|
"icon": "./favicon.svg",
|
||||||
|
"categories": ["developer", "data", "network"],
|
||||||
|
"tags": ["openapi", "swagger", "har", "schema", "http"],
|
||||||
|
"integration": {
|
||||||
|
"contextVersion": 1,
|
||||||
|
"launchModes": ["navigate", "new-tab"],
|
||||||
|
"embedding": "unsupported"
|
||||||
|
},
|
||||||
|
"requirements": {
|
||||||
|
"secureContext": false,
|
||||||
|
"workers": false,
|
||||||
|
"indexedDb": false,
|
||||||
|
"crossOriginIsolated": false,
|
||||||
|
"topLevelContext": false
|
||||||
|
},
|
||||||
|
"privacy": {
|
||||||
|
"processing": "local",
|
||||||
|
"fileUploads": true,
|
||||||
|
"telemetry": false,
|
||||||
|
"label": "Descriptions and exchanges stay local; generated requests are never executed."
|
||||||
|
},
|
||||||
|
"source": {
|
||||||
|
"repository": "https://git.add-ideas.de/lotobo/api-tools",
|
||||||
|
"license": "GPL-3.0-or-later"
|
||||||
|
},
|
||||||
|
"actions": [
|
||||||
|
{
|
||||||
|
"id": "source",
|
||||||
|
"label": "Source",
|
||||||
|
"url": "https://git.add-ideas.de/lotobo/api-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,130 @@
|
|||||||
|
import { expect, test, type Page } from "@playwright/test";
|
||||||
|
import { Buffer } from "node:buffer";
|
||||||
|
|
||||||
|
const ORIGIN = "http://127.0.0.1:4196";
|
||||||
|
async function watchLocalOnly(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;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("navigates and generates inert examples at a nested path", async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
await page.setViewportSize({ width: 1800, height: 1000 });
|
||||||
|
const external = await watchLocalOnly(page);
|
||||||
|
await page.goto("/deep/nested/api/");
|
||||||
|
await expect(page.getByRole("heading", { name: "API Tools" })).toBeVisible();
|
||||||
|
await expect(page.getByText(/2 operations/iu)).toBeVisible();
|
||||||
|
await page.getByRole("button", { name: /PATCH.*\/books/iu }).click();
|
||||||
|
await expect(page.getByText("Generated request body")).toBeVisible();
|
||||||
|
await expect(page.getByLabel("curl")).toHaveValue(/curl --request PATCH/iu);
|
||||||
|
await page.getByLabel("Search operations").fill("getBook");
|
||||||
|
await expect(page.locator(".operation-list li")).toHaveCount(1);
|
||||||
|
expect(external).toEqual([]);
|
||||||
|
expect(
|
||||||
|
await page
|
||||||
|
.locator(".toolbox-shell__main")
|
||||||
|
.evaluate((node) => getComputedStyle(node).width),
|
||||||
|
).toBe("1440px");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("resolves only explicitly supplied local multi-file references", async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
await page.goto("/deep/nested/api/");
|
||||||
|
const main = `openapi: 3.1.0\ninfo: {title: Multi, version: '1'}\npaths:\n /book:\n get:\n responses:\n '200':\n description: ok\n content:\n application/json:\n schema: {$ref: 'schemas.yaml#/Book'}\n`;
|
||||||
|
const schemas = `Book: {type: object, properties: {title: {type: string, example: Remote Book}}}`;
|
||||||
|
await page.getByTestId("api-file-input").setInputFiles([
|
||||||
|
{
|
||||||
|
name: "openapi.yaml",
|
||||||
|
mimeType: "application/yaml",
|
||||||
|
buffer: Buffer.from(main),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "schemas.yaml",
|
||||||
|
mimeType: "application/yaml",
|
||||||
|
buffer: Buffer.from(schemas),
|
||||||
|
},
|
||||||
|
]);
|
||||||
|
await expect(page.getByText(/1 supporting file/iu)).toBeVisible();
|
||||||
|
await expect(page.getByText(/Remote Book/iu)).toBeVisible();
|
||||||
|
await page.getByLabel("Entry description").selectOption("schemas.yaml");
|
||||||
|
await expect(page.getByText(/3 errors/iu)).toBeVisible();
|
||||||
|
await page.getByLabel("Entry description").selectOption("openapi.yaml");
|
||||||
|
await expect(page.getByText(/Remote Book/iu)).toBeVisible();
|
||||||
|
await page.getByRole("button", { name: "Source" }).click();
|
||||||
|
await expect(
|
||||||
|
page.getByRole("list").getByText("schemas.yaml", { exact: true }),
|
||||||
|
).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("retains a valid model, compares revisions and inspects HAR", async ({
|
||||||
|
page,
|
||||||
|
}) => {
|
||||||
|
await page.goto("/deep/nested/api/");
|
||||||
|
await page.getByLabel("OpenAPI source").fill('not: "unterminated');
|
||||||
|
await page.getByRole("button", { name: "Analyse description" }).click();
|
||||||
|
await expect(page.getByRole("alert")).toContainText("last successful");
|
||||||
|
await expect(
|
||||||
|
page.getByText("/books/{bookId}", { exact: true }).first(),
|
||||||
|
).toBeVisible();
|
||||||
|
await page.getByRole("button", { name: "Compare" }).click();
|
||||||
|
await expect(page.getByText("Operation was added.")).toBeVisible();
|
||||||
|
const pending = page.waitForEvent("download");
|
||||||
|
await page.getByRole("button", { name: "Download JSON" }).click();
|
||||||
|
expect((await pending).suggestedFilename()).toBe(
|
||||||
|
"openapi-change-report.json",
|
||||||
|
);
|
||||||
|
await page.getByRole("button", { name: "Exchanges" }).click();
|
||||||
|
await expect(
|
||||||
|
page.getByRole("cell", { name: "https://api.example.test/books/book-42" }),
|
||||||
|
).toBeVisible();
|
||||||
|
await page
|
||||||
|
.getByLabel("Saved HTTP exchange")
|
||||||
|
.fill(
|
||||||
|
"GET /health HTTP/1.1\nHost: example.test\n\n--- response ---\nHTTP/1.1 204 No Content\n",
|
||||||
|
);
|
||||||
|
await page.getByRole("button", { name: "Inspect saved exchange" }).click();
|
||||||
|
await expect(page.getByRole("cell", { name: "/health" })).toBeVisible();
|
||||||
|
});
|
||||||
|
|
||||||
|
test("integrates help, dark theme, PWA identity and hardened headers", async ({
|
||||||
|
page,
|
||||||
|
request,
|
||||||
|
}) => {
|
||||||
|
await page.goto("/deep/nested/api/");
|
||||||
|
await page.getByRole("button", { name: "Help" }).click();
|
||||||
|
await expect(
|
||||||
|
page.getByRole("dialog", { name: "About API Tools" }),
|
||||||
|
).toContainText("never executes HTTP");
|
||||||
|
await page.keyboard.press("Escape");
|
||||||
|
await page.getByRole("button", { name: "Personalize" }).click();
|
||||||
|
await page.getByRole("button", { name: "Dark" }).click();
|
||||||
|
await expect(page.locator(".toolbox-shell").first()).toHaveAttribute(
|
||||||
|
"data-toolbox-theme",
|
||||||
|
"dark",
|
||||||
|
);
|
||||||
|
expect(
|
||||||
|
await page.evaluate(async () =>
|
||||||
|
Boolean(await navigator.serviceWorker.ready),
|
||||||
|
),
|
||||||
|
).toBe(true);
|
||||||
|
const index = await request.get("/deep/nested/api/");
|
||||||
|
expect(index.headers()["content-security-policy"]).toContain(
|
||||||
|
"connect-src 'self'",
|
||||||
|
);
|
||||||
|
expect(await index.text()).not.toMatch(/\b(?:src|href)=["']\//u);
|
||||||
|
const manifest = await request.get("/deep/nested/api/toolbox-app.json");
|
||||||
|
await expect(manifest.json()).resolves.toMatchObject({
|
||||||
|
id: "de.add-ideas.api-tools",
|
||||||
|
version: "0.1.0",
|
||||||
|
privacy: { processing: "local", telemetry: false },
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
import { render, screen } from "@testing-library/react";
|
||||||
|
import userEvent from "@testing-library/user-event";
|
||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import { Workbench } from "../../src/components/Workbench";
|
||||||
|
|
||||||
|
describe("API workbench", () => {
|
||||||
|
it("navigates operations and retains a model after invalid source", async () => {
|
||||||
|
const user = userEvent.setup();
|
||||||
|
render(<Workbench />);
|
||||||
|
expect(
|
||||||
|
screen.getByRole("heading", { name: "API Tools" }),
|
||||||
|
).toBeInTheDocument();
|
||||||
|
expect(screen.getAllByText("GET", { exact: true })).toHaveLength(2);
|
||||||
|
expect(screen.getByText(/curl --request GET/iu)).toBeInTheDocument();
|
||||||
|
await user.clear(screen.getByLabelText("OpenAPI source"));
|
||||||
|
await user.type(
|
||||||
|
screen.getByLabelText("OpenAPI source"),
|
||||||
|
'not: "unterminated',
|
||||||
|
);
|
||||||
|
await user.click(
|
||||||
|
screen.getByRole("button", { name: "Analyse description" }),
|
||||||
|
);
|
||||||
|
expect(screen.getByRole("alert")).toHaveTextContent(/last successful/iu);
|
||||||
|
expect(
|
||||||
|
screen.getAllByText("/books/{bookId}", { exact: true }),
|
||||||
|
).toHaveLength(3);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("shows security, comparison and exchange workspaces", async () => {
|
||||||
|
const user = userEvent.setup();
|
||||||
|
render(<Workbench />);
|
||||||
|
await user.click(screen.getByRole("button", { name: "Security" }));
|
||||||
|
expect(screen.getByText("bearerAuth", { exact: true })).toBeInTheDocument();
|
||||||
|
await user.click(screen.getByRole("button", { name: "Compare" }));
|
||||||
|
expect(screen.getByText(/Operation was added/iu)).toBeInTheDocument();
|
||||||
|
await user.click(screen.getByRole("button", { name: "Exchanges" }));
|
||||||
|
expect(
|
||||||
|
screen.getByRole("cell", {
|
||||||
|
name: "https://api.example.test/books/book-42",
|
||||||
|
}),
|
||||||
|
).toBeInTheDocument();
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import { compareApis } from "../../src/core/compare";
|
||||||
|
import { inspectHar, inspectRawExchange } from "../../src/core/har";
|
||||||
|
import {
|
||||||
|
collectOperations,
|
||||||
|
operationExample,
|
||||||
|
securityInventory,
|
||||||
|
} from "../../src/core/operations";
|
||||||
|
import { parseApiDocument } from "../../src/core/parse";
|
||||||
|
import { createWorkspace } from "../../src/core/refs";
|
||||||
|
|
||||||
|
const SPEC = `openapi: 3.1.0
|
||||||
|
info: { title: T, version: '1' }
|
||||||
|
servers: [{ url: "https://api.example.test" }]
|
||||||
|
paths:
|
||||||
|
/items/{id}:
|
||||||
|
get:
|
||||||
|
operationId: readItem
|
||||||
|
parameters:
|
||||||
|
- { name: id, in: path, required: true, schema: { type: string, example: "a'b" } }
|
||||||
|
responses:
|
||||||
|
"200": { description: ok, content: { application/json: { schema: { type: object, properties: { id: {type: string} } } } } }
|
||||||
|
components:
|
||||||
|
securitySchemes: { key: { type: apiKey, in: header, name: X-Key } }
|
||||||
|
`;
|
||||||
|
|
||||||
|
describe("operation derivation, comparisons and saved exchanges", () => {
|
||||||
|
it("collects operations, schemes and safely quoted inert commands", () => {
|
||||||
|
const document = parseApiDocument(SPEC, "openapi.yaml");
|
||||||
|
const operations = collectOperations(document.value);
|
||||||
|
expect(operations.map((item) => item.key)).toEqual(["GET /items/{id}"]);
|
||||||
|
const example = operationExample(createWorkspace(document), operations[0]!);
|
||||||
|
expect(example.url).toContain("a'b");
|
||||||
|
expect(example.commands.curl).toContain("curl --request GET");
|
||||||
|
expect(example.commands.fetch).toContain("fetch(");
|
||||||
|
expect(securityInventory(document.value)).toEqual([
|
||||||
|
{ name: "key", type: "apiKey", detail: "header · X-Key" },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("reports a missing local reference without aborting generation", () => {
|
||||||
|
const document = parseApiDocument(
|
||||||
|
"openapi: 3.1.0\ninfo: {title: Missing, version: '1'}\npaths: {/x: {get: {responses: {'200': {description: ok, content: {application/json: {schema: {$ref: 'missing.yaml#/Result'}}}}}}}}",
|
||||||
|
"openapi.yaml",
|
||||||
|
);
|
||||||
|
const operation = collectOperations(document.value)[0]!;
|
||||||
|
const example = operationExample(createWorkspace(document), operation);
|
||||||
|
expect(example.response).toBeUndefined();
|
||||||
|
expect(example.notices.join(" ")).toMatch(/missing\.yaml/iu);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("classifies removed operations and additions", () => {
|
||||||
|
const before = parseApiDocument(SPEC, "before.yaml");
|
||||||
|
const after = parseApiDocument(
|
||||||
|
SPEC.replace(" get:", " post:"),
|
||||||
|
"after.yaml",
|
||||||
|
);
|
||||||
|
expect(compareApis(before, after)).toEqual(
|
||||||
|
expect.arrayContaining([
|
||||||
|
expect.objectContaining({ level: "breaking", path: "GET /items/{id}" }),
|
||||||
|
expect.objectContaining({
|
||||||
|
level: "non-breaking",
|
||||||
|
path: "POST /items/{id}",
|
||||||
|
}),
|
||||||
|
]),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("summarizes HAR and raw exchanges without exposing headers", () => {
|
||||||
|
const har = inspectHar(
|
||||||
|
'{"log":{"entries":[{"time":7,"request":{"method":"POST","url":"https://example.test/x","headers":[{"name":"Authorization","value":"secret"}],"postData":{"text":"abc"}},"response":{"status":201,"headers":[],"content":{"size":9,"mimeType":"application/json"}}}]}}',
|
||||||
|
);
|
||||||
|
expect(har[0]).toMatchObject({
|
||||||
|
method: "POST",
|
||||||
|
status: 201,
|
||||||
|
requestHeaders: 1,
|
||||||
|
requestBytes: 3,
|
||||||
|
responseBytes: 9,
|
||||||
|
});
|
||||||
|
expect(JSON.stringify(har)).not.toContain("secret");
|
||||||
|
expect(
|
||||||
|
inspectRawExchange(
|
||||||
|
"GET /x HTTP/1.1\r\nHost: example.test\r\n\r\n--- response ---\r\nHTTP/1.1 204 No Content\r\nX-Test: yes\r\n",
|
||||||
|
)[0],
|
||||||
|
).toMatchObject({ method: "GET", url: "/x", status: 204 });
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
import { describe, expect, it } from "vitest";
|
||||||
|
import { parseApiDocument, validateOpenApi } from "../../src/core/parse";
|
||||||
|
import {
|
||||||
|
createWorkspace,
|
||||||
|
generateSchemaSample,
|
||||||
|
resolveLocalReference,
|
||||||
|
} from "../../src/core/refs";
|
||||||
|
|
||||||
|
describe("OpenAPI parsing and local references", () => {
|
||||||
|
it("parses JSON and YAML and performs focused validation", () => {
|
||||||
|
const json = parseApiDocument(
|
||||||
|
'{"openapi":"3.0.3","info":{"title":"A","version":"1"},"paths":{}}',
|
||||||
|
"api.json",
|
||||||
|
);
|
||||||
|
const yaml = parseApiDocument(
|
||||||
|
"openapi: 3.1.0\ninfo: { title: A, version: '1' }\npaths: {}\n",
|
||||||
|
"api.yaml",
|
||||||
|
);
|
||||||
|
expect(json.format).toBe("json");
|
||||||
|
expect(yaml.format).toBe("yaml");
|
||||||
|
expect(validateOpenApi(yaml).some((item) => item.level === "error")).toBe(
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("rejects dangerous YAML keys and alias expansion", () => {
|
||||||
|
expect(() =>
|
||||||
|
parseApiDocument("__proto__: { polluted: true }", "bad.yaml"),
|
||||||
|
).toThrow(/prohibited key/iu);
|
||||||
|
const aliases = `x: &x [1, 2]\ny: [${Array.from({ length: 60 }, () => "*x").join(",")}]`;
|
||||||
|
expect(() => parseApiDocument(aliases, "aliases.yaml")).toThrow(/alias/iu);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("resolves supplied relative files and refuses remote references", () => {
|
||||||
|
const entry = parseApiDocument(
|
||||||
|
"openapi: 3.1.0\ninfo: {title: A, version: '1'}\npaths: {}\ncomponents: { schemas: { Pet: { $ref: 'schemas.yaml#/Pet' } } }",
|
||||||
|
"openapi.yaml",
|
||||||
|
);
|
||||||
|
const schemas = parseApiDocument(
|
||||||
|
"Pet: { type: object, properties: { name: { type: string } } }",
|
||||||
|
"schemas.yaml",
|
||||||
|
);
|
||||||
|
const workspace = createWorkspace(entry, [schemas]);
|
||||||
|
expect(
|
||||||
|
resolveLocalReference(workspace, "schemas.yaml#/Pet").value,
|
||||||
|
).toMatchObject({ type: "object" });
|
||||||
|
expect(() =>
|
||||||
|
resolveLocalReference(workspace, "https://example.test/schema.json"),
|
||||||
|
).toThrow(/disabled/iu);
|
||||||
|
expect(
|
||||||
|
validateOpenApi(
|
||||||
|
parseApiDocument(
|
||||||
|
"openapi: 3.1.0\ninfo: {title: A, version: '1'}\npaths: {}\nx: {$ref: 'https://bad.test/x'}",
|
||||||
|
),
|
||||||
|
),
|
||||||
|
).toContainEqual(expect.objectContaining({ level: "error" }));
|
||||||
|
});
|
||||||
|
|
||||||
|
it("generates bounded samples and reports reference cycles", () => {
|
||||||
|
const entry = parseApiDocument(
|
||||||
|
'{"openapi":"3.1.0","info":{"title":"A","version":"1"},"paths":{},"components":{"schemas":{"Node":{"type":"object","properties":{"next":{"$ref":"#/components/schemas/Node"}}}}}}',
|
||||||
|
"openapi.json",
|
||||||
|
);
|
||||||
|
const workspace = createWorkspace(entry);
|
||||||
|
const schema = resolveLocalReference(
|
||||||
|
workspace,
|
||||||
|
"#/components/schemas/Node",
|
||||||
|
).value;
|
||||||
|
const sample = generateSchemaSample(workspace, schema);
|
||||||
|
expect(sample.value).toMatchObject({
|
||||||
|
next: { next: { $cycle: "openapi.json#/components/schemas/Node" } },
|
||||||
|
});
|
||||||
|
expect(sample.notices[0]).toMatch(/cycle/iu);
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -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