diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..51e99bf
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,17 @@
+name: CI
+
+on:
+ push:
+ branches:
+ - '**'
+ pull_request:
+ branches:
+ - '**'
+
+jobs:
+ lint:
+ runs-on: macos-latest
+ timeout-minutes: 30
+ steps:
+ - uses: actions/checkout@v2
+ - run: swiftlint --strict .
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..31130b6
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata
+DerivedData/
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
diff --git a/.swiftlint.yml b/.swiftlint.yml
new file mode 100644
index 0000000..1af5785
--- /dev/null
+++ b/.swiftlint.yml
@@ -0,0 +1,19 @@
+excluded:
+ - Package.swift
+disabled_rules:
+ - todo
+opt_in_rules:
+ - file_name_no_space
+ - force_unwrapping
+ - function_default_parameter_at_end
+ - implicitly_unwrapped_optional
+ - lower_acl_than_parent
+ - modifier_order
+ - overridden_super_call
+ - unowned_variable_capture
+ - unused_import
+line_length: 100
+identifier_name:
+ excluded:
+ - id
+ - to
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 0000000..2fb2e74
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,675 @@
+### GNU GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+
+
+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.
+
+
+ Copyright (C)
+
+ 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 .
+
+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:
+
+ Copyright (C)
+ 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 .
+
+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 .
diff --git a/Package.swift b/Package.swift
new file mode 100644
index 0000000..6566e67
--- /dev/null
+++ b/Package.swift
@@ -0,0 +1,26 @@
+// swift-tools-version:5.5
+
+import PackageDescription
+
+let package = Package(
+ name: "Peregrine",
+ platforms: [
+ .iOS(.v14)
+ ],
+ products: [
+ .library(
+ name: "Peregrine",
+ targets: ["Peregrine"]
+ ),
+ ],
+ targets: [
+ .target(
+ name: "Peregrine",
+ dependencies: []
+ ),
+ .testTarget(
+ name: "PeregrineTests",
+ dependencies: ["Peregrine"]
+ ),
+ ]
+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1541cb4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,3 @@
+# Peregrine for iOS
+
+TODO
diff --git a/Sources/Peregrine/Call.swift b/Sources/Peregrine/Call.swift
new file mode 100644
index 0000000..48b31a4
--- /dev/null
+++ b/Sources/Peregrine/Call.swift
@@ -0,0 +1,59 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+public struct Call {
+ public let request: Request
+ internal let didRespond: (Response) -> Void
+
+ internal init(request: Request, didRespond: @escaping (Response) -> Void) {
+ self.request = request
+ self.didRespond = didRespond
+ }
+
+ public func respond() {
+ respond(with: Data())
+ }
+
+ public func respond(with data: Data) {
+ respond(Response(data, status: .success))
+ }
+
+ public func respond(with text: String) {
+ respond(Response(text, status: .success))
+ }
+
+ public func respond(with json: T) throws {
+ respond(try Response(json, status: .success))
+ }
+
+ public func fail(_ message: String?, code: String? = nil) {
+ fail(with: CallError(message ?? "Error", code: code))
+ }
+
+ internal func respond(_ response: Response) {
+ didRespond(response)
+ }
+
+ internal func fail(with error: CallError) {
+ let response = try! Response( // swiftlint:disable:this force_try
+ error,
+ status: .error
+ )
+
+ respond(response)
+ }
+}
diff --git a/Sources/Peregrine/CallError.swift b/Sources/Peregrine/CallError.swift
new file mode 100644
index 0000000..05c76b7
--- /dev/null
+++ b/Sources/Peregrine/CallError.swift
@@ -0,0 +1,26 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal struct CallError: Encodable {
+ internal let message: String
+ internal let code: String?
+
+ internal init(_ message: String, code: String? = nil) {
+ self.message = message
+ self.code = code
+ }
+}
diff --git a/Sources/Peregrine/Data+headers.swift b/Sources/Peregrine/Data+headers.swift
new file mode 100644
index 0000000..f4e7e2f
--- /dev/null
+++ b/Sources/Peregrine/Data+headers.swift
@@ -0,0 +1,22 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal extension Data {
+ var headers: Headers {
+ return ["Content-Length": "\(count)"]
+ }
+}
diff --git a/Sources/Peregrine/Event.swift b/Sources/Peregrine/Event.swift
new file mode 100644
index 0000000..2a9e1eb
--- /dev/null
+++ b/Sources/Peregrine/Event.swift
@@ -0,0 +1,36 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+public struct Event: Transferable {
+ public let type: TransferableType = .json
+ public let data: Data
+
+ public init() {
+ data = Data()
+ }
+
+ public init?(_ json: T) {
+ let encoder = JSONEncoder()
+ encoder.dateEncodingStrategy = .iso8601
+
+ do {
+ data = try encoder.encode(json)
+ } catch {
+ return nil
+ }
+ }
+}
diff --git a/Sources/Peregrine/FileServer+Configuration.swift b/Sources/Peregrine/FileServer+Configuration.swift
new file mode 100644
index 0000000..0ead40c
--- /dev/null
+++ b/Sources/Peregrine/FileServer+Configuration.swift
@@ -0,0 +1,31 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension FileServer {
+ internal struct Configuration {
+ internal let scheme: String
+ internal let baseURL: URL
+
+ internal init(
+ scheme: String,
+ baseURL: URL
+ ) {
+ self.scheme = scheme
+ self.baseURL = baseURL
+ }
+ }
+}
diff --git a/Sources/Peregrine/FileServer.swift b/Sources/Peregrine/FileServer.swift
new file mode 100644
index 0000000..4f49815
--- /dev/null
+++ b/Sources/Peregrine/FileServer.swift
@@ -0,0 +1,100 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal final class FileServer: Server, ServerProtocol {
+ internal let configuration: Configuration
+
+ internal init(configuration: Configuration) {
+ self.configuration = configuration
+ }
+
+ internal func respond(
+ to request: URLRequest,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ let url = request.url! // swiftlint:disable:this force_unwrapping
+ let path = normalize(path: url.path)
+ let fileURL = configuration.baseURL.appendingPathComponent(
+ path,
+ isDirectory: false
+ )
+
+ respondWithFile(
+ to: request,
+ fileURL: fileURL,
+ usingHandler: handler
+ )
+ }
+
+ internal func stopResponding(to _: URLRequest) {}
+
+ private func normalize(path: String) -> String {
+ guard let lastCharacter = path.last else {
+ return path
+ }
+
+ switch lastCharacter {
+ case "/":
+ return "\(path)index.html"
+ default:
+ return path
+ }
+ }
+
+ private func respondWithFile(
+ to request: URLRequest,
+ fileURL: URL,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ guard let bytes = try? Data(contentsOf: fileURL) else {
+ log(
+ """
+ File not found at '\(fileURL.absoluteString)'. Server will \
+ respond with 404 Not Found.
+ """,
+ level: .warn
+ )
+
+ respondWithNotFound(
+ to: request,
+ message: "Not Found",
+ usingHandler: handler
+ )
+
+ return
+ }
+
+ let url = request.url! // swiftlint:disable:this force_unwrapping
+ let mimeType = MimeType(forExtension: fileURL.pathExtension)
+ let httpHeaders = headers()
+ .merging(bytes.headers) { $1 }
+ .merging(mimeType.headers) { $1 }
+
+ let httpResponse = HTTPURLResponse(
+ url: url,
+ statusCode: 200,
+ httpVersion: nil,
+ headerFields: httpHeaders
+ )! // swiftlint:disable:this force_unwrapping
+
+ respond(
+ response: httpResponse,
+ body: bytes,
+ usingHandler: handler
+ )
+ }
+}
diff --git a/Sources/Peregrine/Frame.swift b/Sources/Peregrine/Frame.swift
new file mode 100644
index 0000000..f695007
--- /dev/null
+++ b/Sources/Peregrine/Frame.swift
@@ -0,0 +1,23 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+import SwiftUI
+
+public protocol Frame {
+ associatedtype FrameView: View
+
+ var view: FrameView { get }
+}
diff --git a/Sources/Peregrine/Log.swift b/Sources/Peregrine/Log.swift
new file mode 100644
index 0000000..e40efd3
--- /dev/null
+++ b/Sources/Peregrine/Log.swift
@@ -0,0 +1,42 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal enum LogLevel: String, CustomStringConvertible {
+ case error
+ case warn
+ case info
+ case debug
+
+ var description: String {
+ switch self {
+ case .error:
+ return "\u{1F6A8} \(rawValue.uppercased()) \u{1F6A8}"
+ default:
+ return rawValue
+ }
+ }
+}
+
+let dateFormatter = ISO8601DateFormatter()
+
+internal func log(_ message: String, level: LogLevel = .info) {
+ let date = Date()
+ let message =
+ "Peregrine: \(dateFormatter.string(from: date)) \(String(describing: level)): \(message)"
+
+ print(message)
+}
diff --git a/Sources/Peregrine/MimeType+CustomStringConvertible.swift b/Sources/Peregrine/MimeType+CustomStringConvertible.swift
new file mode 100644
index 0000000..bcaea3e
--- /dev/null
+++ b/Sources/Peregrine/MimeType+CustomStringConvertible.swift
@@ -0,0 +1,22 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension MimeType: CustomStringConvertible {
+ var description: String {
+ return mimeType
+ }
+}
diff --git a/Sources/Peregrine/MimeType+init+forExtension.swift b/Sources/Peregrine/MimeType+init+forExtension.swift
new file mode 100644
index 0000000..9398ae5
--- /dev/null
+++ b/Sources/Peregrine/MimeType+init+forExtension.swift
@@ -0,0 +1,39 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import UniformTypeIdentifiers
+
+extension MimeType {
+ internal init(forExtension ext: String) {
+ let types = UTType.types(
+ tag: ext,
+ tagClass: .filenameExtension,
+ conformingTo: nil
+ )
+
+ guard let type = types.first,
+ let preferredMIMEType = type.preferredMIMEType
+ else {
+ self = .binary(nil)
+ return
+ }
+
+ if type.conforms(to: UTType.text) {
+ self = .text(preferredMIMEType)
+ } else {
+ self = .binary(preferredMIMEType)
+ }
+ }
+}
diff --git a/Sources/Peregrine/MimeType.swift b/Sources/Peregrine/MimeType.swift
new file mode 100644
index 0000000..8443e60
--- /dev/null
+++ b/Sources/Peregrine/MimeType.swift
@@ -0,0 +1,49 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+internal enum MimeType {
+ case binary(String?)
+ case text(String?)
+
+ var mimeType: String {
+ switch self {
+ case let .binary(binaryType):
+ guard let type = binaryType else {
+ return "application/octet-stream"
+ }
+
+ return type
+ case let .text(textType):
+ guard let type = textType else {
+ return "text/plain"
+ }
+
+ return type
+ }
+ }
+
+ var contentType: String {
+ switch self {
+ case .text:
+ return "\(mimeType); charset=utf-8"
+ default:
+ return mimeType
+ }
+ }
+
+ var headers: Headers {
+ return ["Content-Type": contentType]
+ }
+}
diff --git a/Sources/Peregrine/PathHandler.swift b/Sources/Peregrine/PathHandler.swift
new file mode 100644
index 0000000..985717a
--- /dev/null
+++ b/Sources/Peregrine/PathHandler.swift
@@ -0,0 +1,60 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+public struct PathHandlerResponse {
+ let statusCode: Int
+ let responseHeaders: [String: String]
+ let data: Data
+}
+
+public protocol PathHandler {
+ func handle(path: String) -> PathHandlerResponse
+}
+
+public class InternalStoragePathHandler: PathHandler {
+ let directory: URL
+
+ public init(directory: URL) {
+ self.directory = directory
+ }
+
+ public func handle(path: String) -> PathHandlerResponse {
+ let url = directory.appendingPathComponent(path)
+ let bytes: Data
+ let mimeType: MimeType
+ let statusCode: Int
+
+ do {
+ bytes = try Data(contentsOf: url)
+ mimeType = MimeType(forExtension: url.pathExtension)
+ statusCode = 200
+ } catch {
+ mimeType = MimeType.text(nil)
+ bytes = Data("Not Found".utf8)
+ statusCode = 404
+ }
+
+ let headers = mimeType.headers
+ .merging(bytes.headers) { $1 }
+
+ return PathHandlerResponse(
+ statusCode: statusCode,
+ responseHeaders: headers,
+ data: bytes
+ )
+ }
+}
diff --git a/Sources/Peregrine/PathMatcher.swift b/Sources/Peregrine/PathMatcher.swift
new file mode 100644
index 0000000..46904dd
--- /dev/null
+++ b/Sources/Peregrine/PathMatcher.swift
@@ -0,0 +1,45 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal class PathMatcher {
+ internal let baseURL: URL
+ internal let handler: PathHandler
+
+ internal init(baseURL: URL, handler: PathHandler) {
+ self.baseURL = baseURL
+ self.handler = handler
+ }
+
+ internal func matches(url: URL) -> Bool {
+ if baseURL.scheme != url.scheme {
+ return false
+ }
+
+ if baseURL.host != url.host {
+ return false
+ }
+
+ return url.path.starts(with: baseURL.path)
+ }
+
+ internal func handle(url: URL) -> PathHandlerResponse {
+ let pathComponents = url.pathComponents[baseURL.pathComponents.count...]
+ let path = pathComponents.joined(separator: "/")
+
+ return handler.handle(path: path)
+ }
+}
diff --git a/Sources/Peregrine/RPCServer+Configuration.swift b/Sources/Peregrine/RPCServer+Configuration.swift
new file mode 100644
index 0000000..69f1968
--- /dev/null
+++ b/Sources/Peregrine/RPCServer+Configuration.swift
@@ -0,0 +1,53 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension RPCServer {
+ internal struct Configuration {
+ internal let scheme: String
+ internal let allowedOrigin: String
+ internal let remoteInterface: RemoteInterface?
+ internal let pathMatchers: [PathMatcher]?
+ internal let baseURL: URL
+
+ internal init(
+ scheme: String,
+ allowedOrigin: String,
+ remoteInterface: RemoteInterface?,
+ pathHandlers: [String: PathHandler]?
+ ) {
+ self.scheme = scheme
+ self.allowedOrigin = allowedOrigin
+ self.remoteInterface = remoteInterface
+
+ let baseURL = URL(string: "\(scheme):///")! // swiftlint:disable:this force_unwrapping
+ let userBaseURL = baseURL.appendingPathComponent(userNamespace)
+
+ if let handlers = pathHandlers {
+ self.pathMatchers = handlers.map { (path, pathHandler) in
+ return PathMatcher(
+ baseURL: userBaseURL.appendingPathComponent(path),
+ handler: pathHandler
+ )
+ }
+ } else {
+ self.pathMatchers = nil
+ }
+
+ self.baseURL = baseURL
+ }
+ }
+}
diff --git a/Sources/Peregrine/RPCServer+Operation.swift b/Sources/Peregrine/RPCServer+Operation.swift
new file mode 100644
index 0000000..bc6601d
--- /dev/null
+++ b/Sources/Peregrine/RPCServer+Operation.swift
@@ -0,0 +1,48 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension RPCServer {
+ internal enum Operation {
+ case invoke(String, Data)
+ case subscribe
+ case user(URL)
+
+ internal init(request: URLRequest) throws {
+ let url = request.url! // swiftlint:disable:this force_unwrapping
+ let namespace = url.pathComponents[1]
+
+ switch namespace {
+ case RPCServer.rpcNamespace:
+ let operation = url.pathComponents[2]
+ switch operation {
+ case "invoke":
+ let method = url.pathComponents[3]
+ let body = request.httpBody ?? Data()
+ self = .invoke(method, body)
+ case "subscribe":
+ self = .subscribe
+ default:
+ throw OperationError.unknownOperation(operation)
+ }
+ case RPCServer.userNamespace:
+ self = .user(url)
+ default:
+ throw OperationError.unknownNamespace(namespace)
+ }
+ }
+ }
+}
diff --git a/Sources/Peregrine/RPCServer+OperationError.swift b/Sources/Peregrine/RPCServer+OperationError.swift
new file mode 100644
index 0000000..c5674d5
--- /dev/null
+++ b/Sources/Peregrine/RPCServer+OperationError.swift
@@ -0,0 +1,21 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+extension RPCServer {
+ internal enum OperationError: Error {
+ case unknownNamespace(String)
+ case unknownOperation(String)
+ }
+}
diff --git a/Sources/Peregrine/RPCServer+RPCError.swift b/Sources/Peregrine/RPCServer+RPCError.swift
new file mode 100644
index 0000000..6efd079
--- /dev/null
+++ b/Sources/Peregrine/RPCServer+RPCError.swift
@@ -0,0 +1,27 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+extension RPCServer {
+ internal enum RPCError: CustomStringConvertible {
+ case unknownMethod
+
+ var description: String {
+ switch self {
+ case .unknownMethod:
+ return "PEREGRINE_UNKNOWN_METHOD"
+ }
+ }
+ }
+}
diff --git a/Sources/Peregrine/RPCServer.swift b/Sources/Peregrine/RPCServer.swift
new file mode 100644
index 0000000..b9e9841
--- /dev/null
+++ b/Sources/Peregrine/RPCServer.swift
@@ -0,0 +1,270 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Combine
+import Foundation
+
+internal final class RPCServer: Server, ServerProtocol {
+ internal static let rpcNamespace: String = "__rpc__"
+ internal static let userNamespace: String = "__user__"
+
+ internal let configuration: Configuration
+
+ private var subscriptionRequest: URLRequest?
+ private var subscriptionHandler: ServerResponseHandler?
+ private var subscriptions: Set = Set()
+
+ internal init(configuration: Configuration) {
+ self.configuration = configuration
+ super.init()
+ }
+
+ override internal func headers() -> Headers {
+ let baseHeaders = super.headers()
+ let headers = [
+ "Access-Control-Allow-Origin": configuration.allowedOrigin
+ ]
+
+ return headers.merging(baseHeaders) { $1 }
+ }
+
+ private func operation(
+ fromRequest request: URLRequest,
+ usingHandler handler: ServerResponseHandler
+ ) -> Operation? {
+ do {
+ return try Operation(request: request)
+ } catch let OperationError.unknownNamespace(namespace) {
+ respondWithNotFound(
+ to: request,
+ message: "Unknown namespace: \(namespace)",
+ usingHandler: handler
+ )
+ } catch let OperationError.unknownOperation(operation) {
+ respondWithNotFound(
+ to: request,
+ message: "Unknown RPC operation: \(operation)",
+ usingHandler: handler
+ )
+ } catch {
+ log(
+ """
+ Unknown error: \(String(describing: error))
+ """,
+ level: .error
+ )
+
+ respondWithInternalError(
+ to: request,
+ message: "Internal Server Error",
+ usingHandler: handler
+ )
+ }
+
+ return nil
+ }
+
+ internal func respond(
+ to request: URLRequest,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ guard let operation = operation(fromRequest: request, usingHandler: handler) else {
+ return
+ }
+
+ switch operation {
+ case let .invoke(method, body):
+ invoke(method: method, with: body) { response in
+ self.respond(
+ to: request,
+ with: response,
+ usingHandler: handler
+ )
+ }
+ case .subscribe:
+ subscribe(request: request, usingHandler: handler)
+ case let .user(url):
+ guard let matchers = configuration.pathMatchers else {
+ respondWithNotFound(
+ to: request,
+ message: "No path handlers registered.",
+ usingHandler: handler
+ )
+
+ return
+ }
+
+ guard let matcher = matchers.first(where: { $0.matches(url: url) }) else {
+ respondWithNotFound(
+ to: request,
+ message: "No path handler found for URL: \(url.absoluteString).",
+ usingHandler: handler
+ )
+
+ return
+ }
+
+ respond(
+ to: url,
+ usingMatcher: matcher,
+ usingHandler: handler
+ )
+ }
+ }
+
+ private func respond(
+ to request: URLRequest,
+ with response: Response,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ let url = request.url! // swiftlint:disable:this force_unwrapping
+ let httpHeaders = headers()
+ .merging(response.data.headers) { $1 }
+ .merging(response.mimeType.headers) { $1 }
+
+ let httpResponse = HTTPURLResponse(
+ url: url,
+ statusCode: response.statusCode,
+ httpVersion: nil,
+ headerFields: httpHeaders
+ )! // swiftlint:disable:this force_unwrapping
+
+ respond(
+ response: httpResponse,
+ body: response.data,
+ usingHandler: handler
+ )
+ }
+
+ private func respond(
+ to url: URL,
+ usingMatcher matcher: PathMatcher,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ let response = matcher.handle(url: url)
+
+ let httpResponse = HTTPURLResponse(
+ url: url,
+ statusCode: response.statusCode,
+ httpVersion: nil,
+ headerFields: headers().merging(response.responseHeaders) { $1 }
+ )! // swiftlint:disable:this force_unwrapping
+
+ respond(
+ response: httpResponse,
+ body: response.data,
+ usingHandler: handler
+ )
+ }
+
+ internal func stopResponding(to request: URLRequest) {
+ if request == subscriptionRequest {
+ subscriptionHandler = nil
+ subscriptionRequest = nil
+ }
+ }
+
+ private func invoke(
+ method methodKey: String,
+ with body: Data,
+ didReceive: @escaping (Response) -> Void
+ ) {
+ let call = Call(request: Request(data: body)) { response in
+ didReceive(response)
+ }
+
+ guard let method = configuration.remoteInterface?.functions[methodKey] else {
+ call.fail(
+ "Unknown function: \(methodKey)",
+ code: RPCError.unknownMethod.description
+ )
+
+ return
+ }
+
+ method(call)
+ }
+
+ private func subscribe(
+ request: URLRequest,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ let url = request.url! // swiftlint:disable:this force_unwrapping
+ let httpHeaders = headers()
+ .merging(["Content-Type": "text/event-stream"]) { $1 }
+ let httpResponse = HTTPURLResponse(
+ url: url,
+ statusCode: 200,
+ httpVersion: nil,
+ headerFields: httpHeaders
+ )! // swiftlint:disable:this force_unwrapping
+
+ handler.didReceive(response: httpResponse)
+
+ subscriptionRequest = request
+ subscriptionHandler = handler
+
+ for (observableName, observable) in configuration.remoteInterface?.observables ?? [:] {
+ observable
+ .dropFirst()
+ .filter { $0 != nil }
+ .receive(on: RunLoop.main)
+ .sink { event in
+ self.handle(
+ event: event!, // swiftlint:disable:this force_unwrapping
+ with: observableName
+ )
+ }
+ .store(in: &subscriptions)
+ }
+ }
+
+ private func handle(event: Event, with key: String) {
+ let value = event.data
+
+ guard let handler = subscriptionHandler else {
+ // TODO: this isn't possible anymore: remove or refactor
+
+ let decodedValue = String(decoding: value, as: UTF8.self)
+
+ log(
+ """
+ Observable '\(key)' sent value '\(decodedValue)' while the \
+ subscription connection was not active (likely because it was \
+ not yet established). This value will not be delivered to the \
+ client.
+ """,
+ level: .warn
+ )
+
+ return
+ }
+
+ let bytes = (
+ Data("data: \(key)".utf8) +
+ value +
+ Data("\n\n".utf8)
+ )
+
+ handler.didReceive(bytes: bytes)
+
+ log(
+ """
+ Observable '\(key)' sent \(value.count) bytes.
+ """,
+ level: .debug
+ )
+ }
+}
diff --git a/Sources/Peregrine/RemoteInterface.swift b/Sources/Peregrine/RemoteInterface.swift
new file mode 100644
index 0000000..6d87a95
--- /dev/null
+++ b/Sources/Peregrine/RemoteInterface.swift
@@ -0,0 +1,38 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Combine
+
+/// The signature for remote functions.
+public typealias RemoteFunction = (_: Call) -> Void
+
+/// A dictionary of function names -> functions.
+public typealias RemoteFunctions = [String: RemoteFunction]
+
+/// A publisher of events.
+public typealias RemoteObservable = AnyPublisher
+
+/// A dictionary of observable names -> observables.
+public typealias RemoteObservables = [String: RemoteObservable]
+
+public struct RemoteInterface {
+ let functions: RemoteFunctions
+ let observables: RemoteObservables
+
+ public init(functions: RemoteFunctions, observables: RemoteObservables) {
+ self.functions = functions
+ self.observables = observables
+ }
+}
diff --git a/Sources/Peregrine/Request.swift b/Sources/Peregrine/Request.swift
new file mode 100644
index 0000000..96281f4
--- /dev/null
+++ b/Sources/Peregrine/Request.swift
@@ -0,0 +1,25 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+public struct Request: Transferable {
+ public let type: TransferableType = .data
+ public let data: Data
+
+ internal init(data: Data) {
+ self.data = data
+ }
+}
diff --git a/Sources/Peregrine/Response+statusCode.swift b/Sources/Peregrine/Response+statusCode.swift
new file mode 100644
index 0000000..cfe9007
--- /dev/null
+++ b/Sources/Peregrine/Response+statusCode.swift
@@ -0,0 +1,25 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+extension Response {
+ internal var statusCode: Int {
+ switch status {
+ case .success:
+ return 200
+ case .error:
+ return 400
+ }
+ }
+}
diff --git a/Sources/Peregrine/Response.swift b/Sources/Peregrine/Response.swift
new file mode 100644
index 0000000..bc21e98
--- /dev/null
+++ b/Sources/Peregrine/Response.swift
@@ -0,0 +1,48 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal enum ResponseStatus {
+ case success
+ case error
+}
+
+internal struct Response: Transferable {
+ internal let type: TransferableType
+ internal let data: Data
+ internal let status: ResponseStatus
+
+ internal init(_ data: Data, status: ResponseStatus) {
+ type = .data
+ self.data = data
+ self.status = status
+ }
+
+ internal init(_ text: String, status: ResponseStatus) {
+ type = .text
+ data = Data(text.utf8)
+ self.status = status
+ }
+
+ internal init(_ json: T, status: ResponseStatus) throws {
+ let encoder = JSONEncoder()
+ encoder.dateEncodingStrategy = .iso8601
+
+ type = .json
+ data = try encoder.encode(json)
+ self.status = status
+ }
+}
diff --git a/Sources/Peregrine/SchemeHandler.swift b/Sources/Peregrine/SchemeHandler.swift
new file mode 100644
index 0000000..b5211ec
--- /dev/null
+++ b/Sources/Peregrine/SchemeHandler.swift
@@ -0,0 +1,62 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import WebKit
+
+internal struct SchemeHandlerServerResponseHandler: ServerResponseHandler {
+ internal let task: WKURLSchemeTask
+
+ func didReceive(response: URLResponse) {
+ task.didReceive(response)
+ }
+
+ func didReceive(bytes: Data) {
+ task.didReceive(bytes)
+ }
+
+ func didFinish() {
+ task.didFinish()
+ }
+}
+
+internal class SchemeHandler: NSObject, WKURLSchemeHandler {
+ internal let server: T
+ internal let queue: DispatchQueue
+
+ internal init(server: T, queue: DispatchQueue) {
+ self.server = server
+ self.queue = queue
+ }
+
+ internal func webView(_: WKWebView, start task: WKURLSchemeTask) {
+ queue.async {
+ let request = task.request
+ let handler = SchemeHandlerServerResponseHandler(task: task)
+
+ self.server.respond(to: request, usingHandler: handler)
+ }
+ }
+
+ internal func webView(_: WKWebView, stop task: WKURLSchemeTask) {
+ queue.async {
+ let request = task.request
+ self.server.stopResponding(to: request)
+ }
+ }
+}
+
+internal final class AppSchemeHandler: SchemeHandler {}
+
+internal final class RPCSchemeHandler: SchemeHandler {}
diff --git a/Sources/Peregrine/Server+respondWithBadRequest.swift b/Sources/Peregrine/Server+respondWithBadRequest.swift
new file mode 100644
index 0000000..0114eb2
--- /dev/null
+++ b/Sources/Peregrine/Server+respondWithBadRequest.swift
@@ -0,0 +1,31 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension Server {
+ internal func respondWithBadRequest(
+ to request: URLRequest,
+ message: String,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ respondWithMessage(
+ to: request,
+ message: message,
+ statusCode: 400,
+ usingHandler: handler
+ )
+ }
+}
diff --git a/Sources/Peregrine/Server+respondWithInternalError.swift b/Sources/Peregrine/Server+respondWithInternalError.swift
new file mode 100644
index 0000000..6324619
--- /dev/null
+++ b/Sources/Peregrine/Server+respondWithInternalError.swift
@@ -0,0 +1,31 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension Server {
+ internal func respondWithInternalError(
+ to request: URLRequest,
+ message: String,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ respondWithMessage(
+ to: request,
+ message: message,
+ statusCode: 500,
+ usingHandler: handler
+ )
+ }
+}
diff --git a/Sources/Peregrine/Server+respondWithNotFound.swift b/Sources/Peregrine/Server+respondWithNotFound.swift
new file mode 100644
index 0000000..a7d7903
--- /dev/null
+++ b/Sources/Peregrine/Server+respondWithNotFound.swift
@@ -0,0 +1,31 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension Server {
+ internal func respondWithNotFound(
+ to request: URLRequest,
+ message: String,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ respondWithMessage(
+ to: request,
+ message: message,
+ statusCode: 404,
+ usingHandler: handler
+ )
+ }
+}
diff --git a/Sources/Peregrine/Server.swift b/Sources/Peregrine/Server.swift
new file mode 100644
index 0000000..70ad94c
--- /dev/null
+++ b/Sources/Peregrine/Server.swift
@@ -0,0 +1,61 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal class Server {
+ internal func headers() -> Headers {
+ return [
+ "Cache-Control": "no-cache",
+ "Server": "Peregrine"
+ ]
+ }
+
+ internal func respondWithMessage(
+ to request: URLRequest,
+ message: String,
+ statusCode: Int,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ let url = request.url! // swiftlint:disable:this force_unwrapping
+ let bytes = Data(message.utf8)
+ let httpHeaders = headers()
+ .merging(bytes.headers) { $1 }
+ .merging(MimeType.text(nil).headers) { $1 }
+
+ let httpResponse = HTTPURLResponse(
+ url: url,
+ statusCode: statusCode,
+ httpVersion: nil,
+ headerFields: httpHeaders
+ )! // swiftlint:disable:this force_unwrapping
+
+ respond(
+ response: httpResponse,
+ body: bytes,
+ usingHandler: handler
+ )
+ }
+
+ internal func respond(
+ response: URLResponse,
+ body bytes: Data,
+ usingHandler handler: ServerResponseHandler
+ ) {
+ handler.didReceive(response: response)
+ handler.didReceive(bytes: bytes)
+ handler.didFinish()
+ }
+}
diff --git a/Sources/Peregrine/ServerProtocol.swift b/Sources/Peregrine/ServerProtocol.swift
new file mode 100644
index 0000000..00fcc93
--- /dev/null
+++ b/Sources/Peregrine/ServerProtocol.swift
@@ -0,0 +1,29 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+internal typealias Headers = [String: String]
+
+internal protocol ServerResponseHandler {
+ func didReceive(response: URLResponse)
+ func didReceive(bytes: Data)
+ func didFinish()
+}
+
+internal protocol ServerProtocol {
+ func respond(to: URLRequest, usingHandler: ServerResponseHandler)
+ func stopResponding(to: URLRequest)
+}
diff --git a/Sources/Peregrine/Transferable+json.swift b/Sources/Peregrine/Transferable+json.swift
new file mode 100644
index 0000000..fb3dc1d
--- /dev/null
+++ b/Sources/Peregrine/Transferable+json.swift
@@ -0,0 +1,22 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension Transferable {
+ public func json(_ type: T.Type) throws -> T {
+ return try JSONDecoder().decode(type, from: data)
+ }
+}
diff --git a/Sources/Peregrine/Transferable+mimeType.swift b/Sources/Peregrine/Transferable+mimeType.swift
new file mode 100644
index 0000000..30c7270
--- /dev/null
+++ b/Sources/Peregrine/Transferable+mimeType.swift
@@ -0,0 +1,27 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+extension Transferable {
+ internal var mimeType: MimeType {
+ switch type {
+ case .data:
+ return MimeType.binary(nil)
+ case .text:
+ return MimeType.text(nil)
+ case .json:
+ return MimeType.text("application/json")
+ }
+ }
+}
diff --git a/Sources/Peregrine/Transferable+text.swift b/Sources/Peregrine/Transferable+text.swift
new file mode 100644
index 0000000..983753c
--- /dev/null
+++ b/Sources/Peregrine/Transferable+text.swift
@@ -0,0 +1,20 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+extension Transferable {
+ public var text: String {
+ String(decoding: data, as: UTF8.self)
+ }
+}
diff --git a/Sources/Peregrine/Transferable.swift b/Sources/Peregrine/Transferable.swift
new file mode 100644
index 0000000..28a3b46
--- /dev/null
+++ b/Sources/Peregrine/Transferable.swift
@@ -0,0 +1,27 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+public enum TransferableType {
+ case data
+ case text
+ case json
+}
+
+public protocol Transferable {
+ var type: TransferableType { get }
+ var data: Data { get }
+}
diff --git a/Sources/Peregrine/WebFrame+Configuration.swift b/Sources/Peregrine/WebFrame+Configuration.swift
new file mode 100644
index 0000000..e5b91fb
--- /dev/null
+++ b/Sources/Peregrine/WebFrame+Configuration.swift
@@ -0,0 +1,65 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import Foundation
+
+extension WebFrame {
+ public final class Configuration {
+ /// The URL from which to load HTML.
+ ///
+ /// If `baseURL` is a file URL, the files are loaded from the device at the
+ /// specified URL using the built-in `app://` server. Otherwise, files are
+ /// loaded from the specified URL as remote resources.
+ public let baseURL: URL
+ public let remoteInterface: RemoteInterface?
+ public let pathHandlers: [String: PathHandler]?
+
+ internal static let appScheme = "app"
+ internal static let rpcScheme = "peregrine"
+
+ internal var appURL: URL {
+ if baseURL.isFileURL {
+ let indexPath = "\(Configuration.appScheme):///"
+ return URL(string: indexPath)! // swiftlint:disable:this force_unwrapping
+ } else {
+ return baseURL
+ }
+ }
+
+ internal var allowedOrigin: String {
+ if baseURL.isFileURL {
+ return "\(Configuration.appScheme)://"
+ } else {
+ return baseURL.absoluteString
+ }
+ }
+
+ internal var namespace: String { Bundle.main.bundleIdentifier ?? "global" }
+ internal var queueLabel: String { "\(namespace).peregrine" }
+
+ public init(
+ baseURL: URL = Bundle.main.url(
+ forResource: "www",
+ withExtension: nil
+ )!, // swiftlint:disable:this force_unwrapping
+ remoteInterface: RemoteInterface? = nil,
+ pathHandlers: [String: PathHandler]? = nil
+ ) {
+ self.baseURL = baseURL
+ self.remoteInterface = remoteInterface
+ self.pathHandlers = pathHandlers
+ }
+ }
+}
diff --git a/Sources/Peregrine/WebFrame.swift b/Sources/Peregrine/WebFrame.swift
new file mode 100644
index 0000000..924470c
--- /dev/null
+++ b/Sources/Peregrine/WebFrame.swift
@@ -0,0 +1,108 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import WebKit
+
+public final class WebFrame: Frame {
+ internal static func dispatchQueue(from configuration: Configuration)
+ -> DispatchQueue {
+ return DispatchQueue(
+ label: configuration.queueLabel,
+ qos: .userInitiated
+ )
+ }
+
+ internal static func appServer(from configuration: Configuration) -> FileServer? {
+ guard configuration.baseURL.isFileURL else {
+ return nil
+ }
+
+ let appServerConfiguration = FileServer.Configuration(
+ scheme: Configuration.appScheme,
+ baseURL: configuration.baseURL
+ )
+
+ return FileServer(configuration: appServerConfiguration)
+ }
+
+ internal static func rpcServer(from configuration: Configuration) -> RPCServer {
+ let rpcServerConfiguration = RPCServer.Configuration(
+ scheme: Configuration.rpcScheme,
+ allowedOrigin: configuration.allowedOrigin,
+ remoteInterface: configuration.remoteInterface,
+ pathHandlers: configuration.pathHandlers
+ )
+
+ return RPCServer(configuration: rpcServerConfiguration)
+ }
+
+ public let view: WebFrameRepresentable
+
+ internal let configuration: Configuration
+ internal let appServer: FileServer?
+ internal let rpcServer: RPCServer
+ internal let webView: WKWebView
+ internal let webViewNavigationDelegate: WebFrameNavigationDelegate
+
+ public init(configuration: Configuration) {
+ let queue = WebFrame.dispatchQueue(from: configuration)
+
+ appServer = WebFrame.appServer(from: configuration)
+ rpcServer = WebFrame.rpcServer(from: configuration)
+
+ let webViewConfiguration = WKWebViewConfiguration()
+ webViewConfiguration.allowsInlineMediaPlayback = true
+
+ if let appServer = appServer {
+ webViewConfiguration.setURLSchemeHandler(
+ AppSchemeHandler(server: appServer, queue: queue),
+ forURLScheme: appServer.configuration.scheme
+ )
+ }
+
+ webViewConfiguration.setURLSchemeHandler(
+ RPCSchemeHandler(server: rpcServer, queue: queue),
+ forURLScheme: rpcServer.configuration.scheme
+ )
+
+ let webView = WKWebView(frame: .zero, configuration: webViewConfiguration)
+ let webViewNavigationDelegate = WebFrameNavigationDelegate()
+
+ webView.allowsLinkPreview = false
+ webView.navigationDelegate = webViewNavigationDelegate
+ webView.scrollView.bounces = false
+ webView.scrollView.contentInsetAdjustmentBehavior = .never
+
+ self.configuration = configuration
+ self.webView = webView
+ self.webViewNavigationDelegate = webViewNavigationDelegate
+ view = WebFrameRepresentable()
+
+ self.webViewNavigationDelegate.frame = self
+ view.frame = self
+ }
+
+ internal func loadBaseURL() {
+ let request = URLRequest(
+ url: configuration.appURL,
+ cachePolicy: .useProtocolCachePolicy,
+ timeoutInterval: 5
+ )
+
+ let navigation = webView.load(request)
+
+ webViewNavigationDelegate.initialNavigation = navigation
+ }
+}
diff --git a/Sources/Peregrine/WebFrameNavigationDelegate.swift b/Sources/Peregrine/WebFrameNavigationDelegate.swift
new file mode 100644
index 0000000..48b77b0
--- /dev/null
+++ b/Sources/Peregrine/WebFrameNavigationDelegate.swift
@@ -0,0 +1,107 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import WebKit
+
+internal class WebFrameNavigationDelegate: NSObject, WKNavigationDelegate {
+ internal weak var frame: WebFrame?
+ internal weak var initialNavigation: WKNavigation?
+
+ private var _frame: WebFrame {
+ guard let frame = frame else {
+ fatalError("WebFrameNavigationDelegate lost reference to WebFrame.")
+ }
+
+ return frame
+ }
+
+ func webView(
+ _: WKWebView,
+ // swiftlint:disable:next line_length
+ didFailProvisionalNavigation navigation: WKNavigation!, // swiftlint:disable:this implicitly_unwrapped_optional
+ withError error: Error
+ ) {
+ let message =
+ "WebFrame provisional navigation failed: \(String(describing: error))"
+
+ if navigation == initialNavigation {
+ fatalError(message)
+ } else {
+ log(message, level: .error)
+ }
+ }
+
+ func webView(
+ _: WKWebView,
+ didFail navigation: WKNavigation!, // swiftlint:disable:this implicitly_unwrapped_optional
+ withError error: Error
+ ) {
+ let message = "WebFrame navigation failed: \(String(describing: error))"
+
+ if navigation == initialNavigation {
+ fatalError(message)
+ } else {
+ log(message, level: .error)
+ }
+ }
+
+ func webView(
+ _: WKWebView,
+ didFinish navigation: WKNavigation! // swiftlint:disable:this implicitly_unwrapped_optional
+ ) {
+ if navigation == initialNavigation {
+ log("WebFrame loaded initial navigation.", level: .info)
+ }
+ }
+
+ func webView(
+ _: WKWebView,
+ decidePolicyFor navigationAction: WKNavigationAction,
+ decisionHandler: @escaping (WKNavigationActionPolicy) -> Void
+ ) {
+ let appURL = _frame.configuration.appURL
+
+ // Cancel navigation if the request doesn't have a valid URL
+ guard let requestURL = navigationAction.request.url,
+ let requestScheme = requestURL.scheme
+ else {
+ decisionHandler(.cancel)
+ return
+ }
+
+ // Allow navigation to the base URL
+ if requestScheme == appURL.scheme, requestURL.host == appURL.host {
+ decisionHandler(.allow)
+ return
+ }
+ // Allow navigation if the target frame is not the WebView
+ else if let targetFrame = navigationAction.targetFrame, !targetFrame.isMainFrame {
+ decisionHandler(.allow)
+ return
+ }
+ // Otherwise, open the URL as an external link and cancel navigation
+ else {
+ if UIApplication.shared.applicationState == .active {
+ UIApplication.shared.open(
+ requestURL,
+ options: [:],
+ completionHandler: nil
+ )
+ }
+
+ decisionHandler(.cancel)
+ }
+ }
+}
diff --git a/Sources/Peregrine/WebFrameRepresentable.swift b/Sources/Peregrine/WebFrameRepresentable.swift
new file mode 100644
index 0000000..a0b9994
--- /dev/null
+++ b/Sources/Peregrine/WebFrameRepresentable.swift
@@ -0,0 +1,38 @@
+// Peregrine for iOS: native container for hybrid apps
+// Copyright (C) 2022 Caracal LLC
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License version 3 as published
+// by the Free Software Foundation.
+//
+// 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 version 3
+// along with this program. If not, see .
+
+import SwiftUI
+import WebKit
+
+public final class WebFrameRepresentable: UIViewRepresentable {
+ public typealias UIViewType = WKWebView
+
+ internal weak var frame: WebFrame?
+
+ private var _frame: WebFrame {
+ guard let frame = frame else {
+ fatalError("WebFrameRepresentable lost reference to WebFrame.")
+ }
+
+ return frame
+ }
+
+ public final func makeUIView(context _: Context) -> WKWebView {
+ _frame.loadBaseURL()
+ return _frame.webView
+ }
+
+ public final func updateUIView(_: WKWebView, context _: Context) {}
+}
diff --git a/Tests/PeregrineTests/PeregrineTests.swift b/Tests/PeregrineTests/PeregrineTests.swift
new file mode 100644
index 0000000..a28ac82
--- /dev/null
+++ b/Tests/PeregrineTests/PeregrineTests.swift
@@ -0,0 +1,11 @@
+@testable import Peregrine
+import XCTest
+
+final class PeregrineTests: XCTestCase {
+ func testExample() throws {
+ // This is an example of a functional test case.
+ // Use XCTAssert and related functions to verify your tests produce the correct
+ // results.
+ XCTAssertEqual(Peregrine().text, "Hello, World!")
+ }
+}