diff --git a/.cruft.json.license b/.cruft.json.license new file mode 100644 index 0000000..4abe685 --- /dev/null +++ b/.cruft.json.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2024 The Forkbomb Company + +SPDX-License-Identifier: AGPL-3.0-or-later diff --git a/admin/.editorconfig b/.editorconfig similarity index 100% rename from admin/.editorconfig rename to .editorconfig diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..8b4ee31 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,54 @@ +# SPDX-FileCopyrightText: 2024 The Forkbomb Company +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +name: Deploy DIDimo docs + +on: + push: + branches: [main] + paths: [docs/**/*] + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + reuse: + name: 🚨 reuse + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: fsfe/reuse-action@v4 + + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: oven-sh/setup-bun@v2 + with: + bun-version: latest + - uses: actions/configure-pages@v4 + - run: | + bun i + bun run docs:build + working-directory: docs + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs/.vitepress/dist + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/deploy-pages@v4 + id: deployment diff --git a/.gitignore b/.gitignore index 106bf97..ef32a05 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,12 @@ -.bin/slangroom-exec \ No newline at end of file +# SPDX-FileCopyrightText: 2024 The Forkbomb Company +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +docs/.vitepress/cache/ +.bin/slangroom-exec +/pb +/tmp +/pb_data +.DS_Store +.env +pb.env diff --git a/.gitmodules b/.gitmodules index 5afa400..41d4246 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,6 +1,16 @@ -[submodule "admin/zencode/zenflows-crypto"] - path = admin/zencode/zenflows-crypto +# SPDX-FileCopyrightText: 2024 The Forkbomb Company +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +[submodule "zencode/zenflows-crypto"] + path = zencode/zenflows-crypto + url = https://github.com/interfacerproject/zenflows-crypto +[submodule "webapp/zenflows-crypto"] + path = webapp/zenflows-crypto url = https://github.com/interfacerproject/zenflows-crypto [submodule "webapp/client_zencode"] path = webapp/client_zencode url = https://github.com/ForkbombEu/client_zencode +[submodule "webapp/src/lib/openid-vc-typescript-json-schema"] + path = webapp/src/lib/openid-vc-typescript-json-schema + url = https://github.com/ForkbombEu/openid-vc-typescript-json-schema diff --git a/admin/Dockerfile b/Dockerfile similarity index 96% rename from admin/Dockerfile rename to Dockerfile index 2751f2e..907040e 100644 --- a/admin/Dockerfile +++ b/Dockerfile @@ -23,9 +23,9 @@ RUN apk add --no-cache git WORKDIR /app -COPY ./admin/go.mod ./admin/go.sum ./ +COPY ./go.mod ./go.sum ./ RUN go mod download && go mod verify -COPY ./admin/ . +COPY ./ . RUN git init RUN rmdir zencode/zenflows-crypto RUN git submodule add https://github.com/interfacerproject/zenflows-crypto zencode/zenflows-crypto diff --git a/LICENSES/AGPL-3.0-or-later.txt b/LICENSES/AGPL-3.0-or-later.txt new file mode 100644 index 0000000..0c97efd --- /dev/null +++ b/LICENSES/AGPL-3.0-or-later.txt @@ -0,0 +1,235 @@ +GNU AFFERO GENERAL PUBLIC LICENSE +Version 3, 19 November 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 Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are 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. + +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. + +Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. + +A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. + +The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. + +An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. + +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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. + +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 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 work with which it is combined will remain governed by version 3 of the GNU General Public License. + +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + +If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. + +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 AGPL, see . diff --git a/LICENSES/CC-BY-NC-SA-4.0.txt b/LICENSES/CC-BY-NC-SA-4.0.txt new file mode 100644 index 0000000..baee873 --- /dev/null +++ b/LICENSES/CC-BY-NC-SA-4.0.txt @@ -0,0 +1,170 @@ +Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International + + Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors. + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public. + +Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + + c. BY-NC-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + + e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution, NonCommercial, and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. + + i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights under this Public License. + + k. NonCommercial means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange. + + l. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. + + m. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. + + n. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and + + B. produce, reproduce, and Share Adapted Material for NonCommercial purposes only. + + 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. + + B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. + + C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties, including when the Licensed Material is used other than for NonCommercial purposes. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. + + b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. + + 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-NC-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only; + + b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/Makefile b/Makefile index 156cb44..543c48a 100644 --- a/Makefile +++ b/Makefile @@ -6,17 +6,14 @@ help: ## 🛟 Show this help message # - Folder structure - # -ROOT_DIR= $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST)))) - -ADMIN = $(ROOT_DIR)/admin +ROOT_DIR = $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST)))) +ADMIN = $(ROOT_DIR) AZC = $(ADMIN)/zencode/zenflows-crypto PB = $(ADMIN)/pb DATA = $(ADMIN)/pb_data - -WEBAPP = $(ROOT_DIR)/webapp +WEBAPP = $(ROOT_DIR)/webapp WCZ = $(WEBAPP)/client_zencode - -BIN = $(ROOT_DIR)/.bin +BIN = $(ROOT_DIR)/.bin SLANGROOM = $(BIN)/slangroom-exec export PATH := $(BIN):$(PATH) diff --git a/README.md b/README.md index 5ab5254..9651bbb 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,108 @@ -# Didimo + ---- +
-## Setup +# DIDimo +## Your trustworthy compliance checker for decentralized identity solutions -### Backend + +
+

-1. `cd admin && go build` +## 📋 DIDimo Features -### Frontend +DIDimo is a platform designed to ensure that credential issuers and verifiers within decentralized identity ecosystems are compliant with industry standards. Whether you're developing digital wallets, government identity projects, or decentralized apps, DIDimo offers: -1. `cd webapp && pnpm i` +- **Compliance Assessment**: Verify alignment with industry standards for secure and interoperable identity management. +- **Debugging Tools**: Real-time analysis and resolution of cryptographic protocol issues. +- **Interoperability Testing**: Ensure your services work seamlessly with other global systems. +- **Periodic Checks**: Schedule automated compliance checks to maintain ongoing compliance with evolving standards. ---- +DIDimo is more than just a tool – it's a platform designed to foster trust, security, and innovation in the world of decentralized identity. -## Usage +## 🎯 Project Goals -### Backend +- **Promote Interoperability**: Facilitate the adoption of standardized identity solutions that work across various platforms and technologies. +- **Enhance Security**: Provide tools and resources that help developers create secure identity solutions, protecting user data and privacy. +- **Foster Trust**: Build a trustworthy ecosystem where credential issuers and verifiers can demonstrate their compliance with industry standards. +- **Support Innovation**: Encourage the development of cutting-edge identity solutions by providing essential tools for testing, debugging, and compliance checking. -``` -cd admin -./pb serve -``` +# 👉 [DOCUMENTATION](https://forkbombeu.github.io/DIDimo/) -### Frontend +Click the link above to dive into our comprehensive documentation, where you’ll find detailed information about how DIDimo works, how to get started, and how to make the most of its features. -``` -cd webapp -cp .env.example .env -pnpm dev -``` +
-## Usage with docker compose +
-``` -docker compose build -docker compose up -``` +### 🚩 Table of Contents + +- [🚑 Community & support](#-community--support) +- [😍 Acknowledgements](#-acknowledgements) +- [👤 Contributing](#-contributing) +- [💼 License](#-license) + +
+ +*** +## 🚑 Community & support + +**[📝 Documentation](https://forkbombeu.github.io/DIDimo/)** - Getting started and more. + +**[🌱 Ecosystem 👈 🚧 WIP 🚧](https://github.com/forkbombeu/didimo_plugins)** - Plugins, resources, and more. + +**[🚩 Issues](../../issues)** - Bugs end errors you encounter using didimo. + +**[💬 Discussions](../../discussions)** - Get help, ask questions, request features, and discuss. + + +**[🔝 back to top](#toc)** + +*** +## 😍 Acknowledgements + +Copyleft 🄯 2024 by [The Forkbomb Company](https://www.forkbomb.solutions), Amsterdam + + + +Supported by [NGI TRUSTCHAIN](https://trustchain.ngi.eu/), which is made possible with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme. + +**[🔝 back to top](#toc)** + +*** +## 👤 Contributing + +1. 🔀 [FORK IT](../../fork) +2. Create your feature branch `git checkout -b feature/branch` +3. Commit your changes `git commit -am 'feat: New feature\ncloses #398'` +4. Push to the branch `git push origin feature/branch` +5. Create a new Pull Request `gh pr create -f` +6. 🙏 Thank you + + +**[🔝 back to top](#toc)** + +*** +## 💼 License + DIDimo - Your Trustworthy Compliance Checker for Decentralized Identity Solutions + Copyleft 🄯 2024 The Forkbomb company, Amsterdam + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +**[🔝 back to top](#toc)** diff --git a/REUSE.toml b/REUSE.toml new file mode 100644 index 0000000..870ede3 --- /dev/null +++ b/REUSE.toml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2024 Puria Nafisi Azizi +# SPDX-FileCopyrightText: 2024 The Forkbomb Company +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +version = 1 +SPDX-PackageName = "DIDimo" +SPDX-PackageSupplier = "Puria Nafisi Azizi " +SPDX-PackageDownloadLocation = "https://github.com/ForkbombEu/didimo" + +[[annotations]] +path = ["webapp/static/emails", "webapp/.vscode/extensions.json", "webapp/src/app.postcss", "webapp/project.inlang/project_id", "webapp/.env.example", "webapp/.npmrc", "docs/index.md"] +precedence = "override" +SPDX-FileCopyrightText = "2024 The Forkbomb Company" +SPDX-License-Identifier = "AGPL-3.0-or-later" diff --git a/admin/.gitignore b/admin/.gitignore deleted file mode 100644 index 6057de3..0000000 --- a/admin/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -/pb -/tmp -/pb_data -.DS_Store -.env -pb.env diff --git a/admin/README.md b/admin/README.md deleted file mode 100644 index 8575a2d..0000000 --- a/admin/README.md +++ /dev/null @@ -1,68 +0,0 @@ -# Pocketbase backend - -Starter for a backend that includes pocketbase and [keypairoom](https://github.com/LedgerProject/keypairoom) key generation. - -## Run Locally - -``` -docker-compose build -docker-compose up -``` - -## Environment Variables - -To run this project, you will need to add the following environment variables to your .env file - -`SALT`: 32 bytes base64 encoded - -`RESTROOM_URL` the URL of a [zenflows-crypto](https://github.com/interfacerproject/zenflows-crypto) instance - -## Recipes - -To protect a collection using the `authorizations` collection: - -1. Add an `owner` attribute to the model you want to protect -2. Paste this string in the API rules section, where needed - -``` -owner.id = @request.auth.id || (@collection.authorizations.users.id ?= @request.auth.id && @collection.authorizations.record_id ?= id) -``` - -## API Reference - -#### Keypairoom HMAC generation - -```http - GET /api/keypairoom-server -``` - -| Parameter | Type | Description | -| :-------- | :----------- | :----------------------------------- | -| `data` | `dictionary` | **Required**. Identifier of the user | - -## Authors - -- [@albertolerda](https://github.com/albertolerda) -- [@bbtgnn](https://github.com/bbtgnn) -- [@puria](https://github.com/puria) - -## License - -``` -Pocketbase starter - Zenflows economic model API's -Copyleft (ɔ) 2023 Dyne.org foundation - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero 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 Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . - -``` diff --git a/admin/modd.conf b/admin/modd.conf deleted file mode 100644 index e7de4e8..0000000 --- a/admin/modd.conf +++ /dev/null @@ -1,9 +0,0 @@ -# Run go test on ALL modules on startup, and subsequently only on modules -# containing changes. -**/*.go { - prep: go mod tidy - prep: go build - prep: go test -v ./... - # prep: go test @dirmods - daemon +sigterm: ./pb serve --http 0.0.0.0:8090 --publicDir ../frontend/build -} diff --git a/admin/pb_public b/admin/pb_public deleted file mode 120000 index bf07766..0000000 --- a/admin/pb_public +++ /dev/null @@ -1 +0,0 @@ -../webapp/static/ \ No newline at end of file diff --git a/admin/config/config.go b/config/config.go similarity index 100% rename from admin/config/config.go rename to config/config.go diff --git a/admin/did/did.go b/did/did.go similarity index 100% rename from admin/did/did.go rename to did/did.go diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..8cab569 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,179 @@ +# SPDX-FileCopyrightText: 2024 The Forkbomb Company +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore + +# Logs + +logs +_.log +npm-debug.log_ +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Caches + +.cache + +# Diagnostic reports (https://nodejs.org/api/report.html) + +report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json + +# Runtime data + +pids +_.pid +_.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover + +lib-cov + +# Coverage directory used by tools like istanbul + +coverage +*.lcov + +# nyc test coverage + +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) + +.grunt + +# Bower dependency directory (https://bower.io/) + +bower_components + +# node-waf configuration + +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) + +build/Release + +# Dependency directories + +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) + +web_modules/ + +# TypeScript cache + +*.tsbuildinfo + +# Optional npm cache directory + +.npm + +# Optional eslint cache + +.eslintcache + +# Optional stylelint cache + +.stylelintcache + +# Microbundle cache + +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history + +.node_repl_history + +# Output of 'npm pack' + +*.tgz + +# Yarn Integrity file + +.yarn-integrity + +# dotenv environment variable files + +.env +.env.development.local +.env.test.local +.env.production.local +.env.local + +# parcel-bundler cache (https://parceljs.org/) + +.parcel-cache + +# Next.js build output + +.next +out + +# Nuxt.js build / generate output + +.nuxt +dist + +# Gatsby files + +# Comment in the public line in if your project uses Gatsby and not Next.js + +# https://nextjs.org/blog/next-9-1#public-directory-support + +# public + +# vuepress build output + +.vuepress/dist + +# vuepress v2.x temp and cache directory + +.temp + +# Docusaurus cache and generated files + +.docusaurus + +# Serverless directories + +.serverless/ + +# FuseBox cache + +.fusebox/ + +# DynamoDB Local files + +.dynamodb/ + +# TernJS port file + +.tern-port + +# Stores VSCode versions used for testing VSCode extensions + +.vscode-test + +# yarn v2 + +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# IntelliJ based IDEs +.idea + +# Finder (MacOS) folder config +.DS_Store diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts new file mode 100644 index 0000000..86135bc --- /dev/null +++ b/docs/.vitepress/config.ts @@ -0,0 +1,56 @@ +// SPDX-FileCopyrightText: 2024 The Forkbomb Company +// +// SPDX-License-Identifier: AGPL-3.0-or-later + +import { defineConfig } from "vitepress"; +import { generateSidebar } from "vitepress-sidebar"; +import umlPlugin from "markdown-it-plantuml"; + +// https://vitepress.dev/reference/site-config +export default defineConfig({ + title: "DIDimo", + description: + "Master the complexities of SSI identity solutions with DIDimo: Your go-to platform for testing, validating, and ensuring compliance in the ever-evolving digital identity ecosystem.", + base: "/DIDimo/", + + lastUpdated: true, + metaChunk: true, + + head: [ + [ + "script", + {}, + `window.$crisp=[];window.CRISP_WEBSITE_ID="8dd97823-ddac-401e-991a-7498234e4f00";(function(){d=document;s=d.createElement("script");s.src="https://client.crisp.chat/l.js";s.async=1;d.getElementsByTagName("head")[0].appendChild(s);})();`, + ], + ], + themeConfig: { + // https://vitepress.dev/reference/default-theme-config + nav: [ + { text: "Home", link: "/" }, + { text: "Get Started", link: "/Architecture/1_start.html" }, + { text: "API Reference", target: "_self", link: "/API/index.html" }, + ], + + sidebar: generateSidebar({ + useTitleFromFileHeading: true, + sortMenusOrderNumericallyFromLink: true, + }), + logo: "", + socialLinks: [ + { icon: "github", link: "https://github.com/forkbombeu/DIDimo" }, + { icon: "linkedin", link: "https://linkedin.com/company/forkbomb" }, + ], + + footer: { + message: + 'Released under the AGPLv3 License.', + copyright: + 'Copyleft 🄯 2024-present The Forkbomb company', + }, + }, + markdown: { + config(md) { + md.use(umlPlugin); + }, + }, +}); diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts new file mode 100644 index 0000000..1182b63 --- /dev/null +++ b/docs/.vitepress/theme/index.ts @@ -0,0 +1,20 @@ +// SPDX-FileCopyrightText: 2024 The Forkbomb Company +// +// SPDX-License-Identifier: AGPL-3.0-or-later + +// https://vitepress.dev/guide/custom-theme +import type { Theme } from 'vitepress' +import DefaultTheme from 'vitepress/theme' +import matomo from "@datagouv/vitepress-plugin-matomo"; + +export default { + extends: DefaultTheme, + enhanceApp: ({ app, router, siteData }) => { + matomo({ + router: router, + siteID: 10, // Replace with your site id + trackerUrl: "https://matomo.dyne.org/" // Replace with your matomo url + }) + } +} satisfies Theme + diff --git a/docs/Architecture/1_start.md b/docs/Architecture/1_start.md new file mode 100644 index 0000000..777c616 --- /dev/null +++ b/docs/Architecture/1_start.md @@ -0,0 +1,21 @@ + + +# 🎯 Intro and Goals + +New systems have come up with regard to digital identity, which aim at enhancing power among people and organizations over their personal data. In contrast to traditional systems of identity, often centralized and controlled by an individual entity, modern digital identity solutions intend to provide safe, privacy-preserving identities usable across multiple applications, from financial services to interactions with the government. These systems increase security and user experience, all while decreasing the risks of centrally stored data. + +## Problem Statement + +The greater the momentum in digital identity systems, the greater the challenge: interoperability and compliance across a wide range of standards and protocols. The ecosystem is extremely fragmented, and multiple standards are governing cryptography, data formats, and communication protocols. This puts developers in a complex environment as they have to make sure that the services offered in the issuance and verification of credentials conform to multiple, in some cases conflicting, standards. Besides, it becomes difficult to evaluate and compare these services against expectations of security and privacy reliably for end-users and organizations. + +This challenge is further complicated by the fact that key regulations and frameworks are currently being developed and implemented in Europe—for example, the EUDIW, EUDI-ARF, and the updated eIDAS 2.0 regulation—which are surrounded by a lot of uncertainty. These initiatives have the purpose of unifying digital identity across the European Union; however, ongoing discussions and lack of finalized details have kept developers and organizations in limbo. This kind of uncertainty makes it very hard to develop in accordance with possible future requirements while trying to enable compliance. This might act as a barrier to the wide adoption of contemporary digital-identity solutions in Europe. + +Most of the solutions today are focused around one standard, or they have very limited functionality; thus, a void exists in the market for a complete tool that can check compliance against a multitude of standards and return findings that are meaningful and actionable. If there is no interoperability and standardization, risks apply to the developers as well as to the wider adoption of digital identity systems, because in such systems, trust and reliability are inseparable. + +**DIDimo adresses this gap by providing a platform that tests, evaluates, and debugs credential issuers and verifiers against the largest set of standards in the industry for conformance. This not only assisted developers in creating services that were both interoperable and secure but also empowers end-users and organizations to take well-reasoned decisions on the type of digital identity solution that best suits them, despite regulatory uncertainties.** diff --git a/docs/Architecture/2_functionalities.md b/docs/Architecture/2_functionalities.md new file mode 100644 index 0000000..83ce380 --- /dev/null +++ b/docs/Architecture/2_functionalities.md @@ -0,0 +1,73 @@ + + +# 📋 Planned Functionalities + +## 1. Credential Issuer and Verifier Compliance Testing +**Description**: +The core functionality of DIDimo is to allow developers to submit their credential issuance and verification services for compliance testing against multiple standards, such as OpenID4VCI, OpenID4VP, and OpenID Federation. The service will assess cryptographic methods, data formats, and communication protocols. + +**Motivation**: +Given the fragmentation in standards across decentralized identity ecosystems, developers need an easy way to verify that their services comply with required standards. This ensures interoperability and trust within the ecosystem. + +## 2. Periodic Compliance Checks +**Description**: +Offer developers and providers the option to schedule periodic checks to ensure ongoing compliance of their services with evolving standards. Developers can opt-in for these checks, and notifications will be sent if any issues are detected over time. + +**Motivation**: +Standards and best practices evolve over time, and a service that was compliant last year may no longer be. Periodic checks help maintain compliance, which is critical for ongoing trust and interoperability. + +## 3. Privacy-First Data Publishing +**Description**: +Ensure that any data or results from the compliance checks are only published or made publicly visible if the developers or service providers explicitly consent to it. By default, all data remains private. + +**Motivation**: +Privacy is a cornerstone of trust. This feature ensures that developers and providers maintain control over their data, fostering a more trustworthy environment. + +## 4. Debugging and Monitoring Tool +**Description**: +Provide a robust debugging tool that can be deployed locally or as a microservice. This tool will help developers identify issues in real-time during credential issuance or verification processes, enabling faster troubleshooting and iteration. + +**Motivation**: +Debugging decentralized identity solutions can be complex. This tool simplifies the process by offering real-time insights, allowing developers to fix issues quickly and efficiently. + +## 5. Interoperability Testing +**Description**: +Enable developers to test their services for interoperability with other services in the ecosystem. This functionality includes running tests against various identity wallets and verification tools to ensure seamless integration. + +**Motivation**: +Interoperability is key to a cohesive decentralized identity ecosystem. This feature ensures that services can work together, providing a smooth user experience across different platforms and tools. + +## 6. Report Generation and Export +**Description**: +Allow users to generate detailed reports on compliance checks, debugging sessions, and interoperability tests. These reports can be exported in various formats (e.g., PDF, JSON, CSV) for documentation and analysis. + +**Motivation**: +Reports are essential for documentation, compliance audits, and internal reviews. This functionality provides users with the ability to easily generate and share these reports with stakeholders. + +## 7. Developer Dashboard +**Description**: +Create a comprehensive dashboard where developers can manage their services, view compliance statuses, schedule periodic checks, and access reports. The dashboard will also provide insights and recommendations based on test results. + +**Motivation**: +A centralized dashboard streamlines the management of identity services, providing developers with a user-friendly interface to monitor and improve their offerings. + +## 8. End-User Comparison Tool +**Description**: +Develop a comparison tool for end-users that allows them to browse and compare different credential issuance and verification services based on their compliance status, interoperability, and other relevant metrics. + +**Motivation**: +End-users need the ability to make informed decisions about which identity services to use. This tool empowers them by providing transparent, easy-to-understand comparisons. + +## 9. Plugin System for Extensibility +**Description**: +Implement a plugin system that allows for the integration of additional checks and standards as the ecosystem evolves. This system will enable third-party developers to contribute plugins that extend the functionality of DIDimo. + +**Motivation**: +As the decentralized identity space grows, new standards and requirements will emerge. A plugin system ensures that DIDimo remains flexible and can adapt to future needs without requiring significant core changes. + diff --git a/docs/Architecture/3_user_stories.md b/docs/Architecture/3_user_stories.md new file mode 100644 index 0000000..39a8e77 --- /dev/null +++ b/docs/Architecture/3_user_stories.md @@ -0,0 +1,57 @@ + + +# 🧑‍💻 User Stories + +## 1. Developer Stories + +- **As a developer of a decentralized identity service,** I want to submit my credential issuer to DIDimo, so that I can check its compliance with multiple industry standards and ensure it meets the necessary requirements for secure, interoperable identity management. + +- **As a developer testing a new cryptographic protocol,** I want to use DIDimo's debugging tool to analyze and resolve any issues in real-time, so that I can ensure the protocol works correctly before deployment. + +- **As a developer working on a new digital wallet,** I want to access DIDimo's API to automate compliance checks for credentials being issued by my wallet, so that I can integrate compliance assurance directly into my development workflow. + +- **As a developer contributing to an open-source identity project,** I want to deploy DIDimo locally as a microservice, so that I can test my code in an isolated environment and ensure it aligns with global standards. + +- **As a developer doing devops for a identity solution,** I want to schedule periodic compliance checks for my services so that I can maintain ongoing compliance with evolving standards without manual intervention. + +- **As a developer that uses regurlarly DIDimo,** I want a comprehensive dashboard where I can manage my services, view compliance statuses, schedule checks, and access reports so that I can efficiently monitor and improve my offerings. + +- **As a developer or service provider,** I want to upload new compliance tests via DIDimo's API and CLI, so that I can easily add new tests to the platform and ensure they are executed as part of the compliance checks for my credentials issuers. + +## 2. Service providers + +- **As a service provider that wants to show my service features,** I want to have control over whether my compliance check results are published, ensuring that my data is only made public with my explicit consent. + +- **As a service provider that are running audits,** I want to generate and export detailed reports of my compliance checks, debugging sessions, and interoperability tests so that I can document and analyze the results for audits and internal reviews. + +## 3. Institutional Actor Stories + +- **As a governmental IT manager responsible for a national identity project,** I want to use DIDimo to verify that our identity solutions are compliant with both national and international standards, ensuring that our infrastructure is secure and interoperable with other global systems. + +- **As an EU official tasked with ensuring the compliance of digital identity solutions,** I want to use DIDimo to generate compliance reports for various credential issuers and verifiers, so that I can assess their readiness for integration with EUDI wallets. + +## 4. CTO and Business Decision-Maker Stories + +- **As a CTO exploring identity solutions for our company's digital platform,** I want to browse and compare the list of verified credential services on DIDimo, so that I can make an informed decision based on their compliance status and other relevant metrics so that I can choose the best service for my needs. + +- **As a CTO managing multiple digital services,** I want to regularly monitor our services using DIDimo to ensure ongoing compliance with evolving standards, so that we maintain a high level of security and interoperability. + +## 5. End-User (General Public) Stories + +- **As an end-user concerned about privacy,** I want to browse DIDimo's list of verified credential issuers to find those that prioritize privacy and data security, so that I can use services that align with my values. + +- **As a privacy-conscious citizen,** I want to use DIDimo to compare different digital wallets and their compliance with security standards, so that I can choose the most secure option for managing my personal identity. + + +## 6. Researcher and Standardization Body Stories + +- **As a researcher studying decentralized identity systems,** I want to access DIDimo's compliance data to analyze trends and gaps in standard adoption, so that I can contribute to the development of more robust standards. + +- **As a member of a standardization body,** I want to use DIDimo to evaluate how well current credential issuers and verifiers align with emerging standards, so that I can identify areas where additional guidance or revision may be needed. + diff --git a/docs/Architecture/4_building_blocks.md b/docs/Architecture/4_building_blocks.md new file mode 100644 index 0000000..2b6de08 --- /dev/null +++ b/docs/Architecture/4_building_blocks.md @@ -0,0 +1,143 @@ + + +# 🏗️ Building blocks + +The following system diagrams provide a visual overview of the DIDimo platform, illustrating its architecture and key components. These diagrams are based on the C4 model, which is a widely-used approach for visualizing software architecture. + +While we follow the principles of the C4 model, our implementation is somewhat loose, focusing on clarity and relevance to the specific context of DIDimo. The diagrams capture different levels of abstraction, from the overall system context down to detailed component interactions within the platform. This structured approach helps in understanding how various parts of the system interact and contribute to its overall functionality. + + +## System Context diagrams + +Shows the interaction between external actors (developers, service providers, governmental bodies, etc.) and the DIDimo system. + +@startuml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!define I https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/govicons +!include I/users.puml +!include I/user_politician.puml +!include I/user_suit.puml +!include I/ribbon.puml +!include I/presenter.puml + +LAYOUT_WITH_LEGEND() + +title System Context Diagram for DIDimo + +Person(dev, "Developer", "Submits credential issuers and runs compliance checks.") +Person(sp, "Service Provider", "Manages and publishes compliance results.") +Person(gov, "Government IT Manager", "Ensures compliance with standards.", $sprite="user_suit") +Person(eu, "EU Official", "Generates compliance reports.", $sprite="user_politician") +Person(cto, "CTO", "Browses and compares credential services.") +Person(enduser, "End User", "Browses verified credential issuers.", $sprite="users") +Person(researcher, "Researcher", "Analyzes compliance data.", $sprite="presenter") +Person(sb, "Standardization Body", "Evaluates standards alignment.", $sprite="ribbon") + +System(didimo, "DIDimo", "Platform for verifying compliance of decentralized identity services.") + +Rel(dev, didimo, "Submits and checks compliance") +Rel_U(sp, didimo, "Manages and publishes results") +Rel_U(gov, didimo, "Generates compliance reports") +Rel_R(eu, didimo, "Generates compliance reports") +Rel_R(cto, didimo, "Browses and compares services") +Rel_L(enduser, didimo, "Browses verified issuers") +Rel_L(researcher, didimo, "Analyzes compliance data") +Rel(sb, didimo, "Evaluates standards alignment") +Lay_U(enduser, researcher) +Lay_U(cto, eu) +@enduml + +## Container diagrams +Illustrates the main containers within the DIDimo system (API Gateway, Compliance Engine, Dashboard, etc.) and their interactions. + +@startuml +!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml +!define I https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/govicons +!define FA6 https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/font-awesome-4 +!include I/user_politician.puml +!include I/user_suit.puml +!include I/ribbon.puml +!include I/presenter.puml + +LAYOUT_WITH_LEGEND() + +title Container Diagram for DIDimo + +Person(dev, "Developer") +Person(sp, "Service Provider") +Person(gov, "Government IT Manager", $sprite="user_suit") +Person(eu, "EU Official", $sprite="user_politician") +Person(cto, "CTO") +Person(enduser, "End User") +Person(researcher, "Researcher", $sprite="presenter") +Person(sb, "Standardization Body", $sprite="ribbon") + +System_Boundary(didimo, "DIDimo") { + Container(api_gateway, "API Gateway", "golang", "Handles API requests and CLI submissions.") + Container(compliance_engine, "Compliance Engine", "Zenroom / Slangroom", "Performs compliance checks and runs periodic tasks.") + Container(database, "Database", "MongoDB", "Stores compliance data, user data, and reports.") + Container(queue_manager, "Queue Manager", "RabbitMQ / golang", "Manages long-running compliance tasks.") + Container(reporting_service, "Reporting Service", "golang", "Generates and exports compliance reports.") + Container(external_services_api, "External Services API", "APIs", "Connects to external compliance check services.") + Container(dashboard, "Dashboard", "TypeScript/Svelte", "User interface for managing services and viewing results.") + Container(comparison_tool, "Marketplace/Comparison Tool", "TypeScript/Svelte", "Tool for comparing credential services.") +} + +Rel(dev, api_gateway, "Submits credential issuers/checks via API/CLI") +Rel(sp, dashboard, "Manages and publishes results") +Rel(enduser, comparison_tool, "Browses verified issuers") +Rel(cto, dashboard, "Browses and compares services") + +Rel_U(sb, reporting_service, "Evaluates standards alignment") +Rel_U(gov, reporting_service, "Generates compliance reports") +Rel_U(eu, reporting_service, "Generates compliance reports") +Rel_U(researcher, reporting_service, "Accesses compliance data") + +Rel(api_gateway, compliance_engine, "Processes compliance checks") +Rel_L(compliance_engine, database, "Stores compliance results") +Rel(queue_manager, compliance_engine, "Manages long-running tasks") +Rel(compliance_engine, external_services_api, "Uses external services for checks") +Rel(dashboard, compliance_engine, "Schedules periodic checks") +Rel(dashboard, database, "Manages user data") +Rel(comparison_tool, database, "Accesses compliance data") +Rel_U(reporting_service, database, "Fetches data for reports") + +@enduml + + + +## Component Diagram +Focuses on the internal components of the Compliance Engine, showing how the various modules work together. + +@startuml +!include + +!define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons +!define FONTAWESOME https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/font-awesome-5 +!include DEVICONS/go.puml +!include FONTAWESOME/users.puml + +title Component Diagram for Compliance Engine + +Container_Boundary(didimo_backend, "DIDimo Backend - Compliance Engine") { + Component(compliance_engine, "Compliance Engine", "Slangroom/ncr", "Performs all compliance checks.") + Component(standards_checker, "Standards Checker", "Step CI/slangroom", "Validates against various identity standards.") + Component(debugging_tool, "Debugging Tool", "Slangroom/golang", "Helps developers resolve compliance issues.") + Component(periodic_checker, "Periodic Checker", "golang", "Schedules and runs periodic checks.") + Component(external_service_integration, "External Service Integration", "REST", "Connects to external compliance services via APIs.") +} + +Rel(compliance_engine, standards_checker, "Uses for compliance validation") +Rel(compliance_engine, debugging_tool, "Uses for debugging and issue resolution") +Rel(compliance_engine, periodic_checker, "Uses for scheduling periodic checks") +Rel(compliance_engine, external_service_integration, "Uses for external compliance checks") + +@enduml + + diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 5a36813..0000000 --- a/docs/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Building blocks - -# Stake holders - -# Deployment - -# Goals - -# Non-functional requirements - -# Context and scope (external systems and interfaces) - -# Technical debt and risks - -# Glossary diff --git a/docs/bun.lockb b/docs/bun.lockb new file mode 100755 index 0000000..21bbe45 Binary files /dev/null and b/docs/bun.lockb differ diff --git a/docs/bun.lockb.license b/docs/bun.lockb.license new file mode 100644 index 0000000..4abe685 --- /dev/null +++ b/docs/bun.lockb.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2024 The Forkbomb Company + +SPDX-License-Identifier: AGPL-3.0-or-later diff --git a/docs/images/logo/didimo__github.svg b/docs/images/logo/didimo__github.svg new file mode 100644 index 0000000..32a1704 --- /dev/null +++ b/docs/images/logo/didimo__github.svg @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/logo/didimo__github.svg.license b/docs/images/logo/didimo__github.svg.license new file mode 100644 index 0000000..2750c74 --- /dev/null +++ b/docs/images/logo/didimo__github.svg.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2024 Puria Nafisi Azizi +SPDX-FileCopyrightText: 2024 The Forkbomb Company + +SPDX-License-Identifier: CC-BY-NC-SA-4.0 diff --git a/docs/images/logo/didimo_logo_fingerprint.png b/docs/images/logo/didimo_logo_fingerprint.png new file mode 100644 index 0000000..99f1e2c Binary files /dev/null and b/docs/images/logo/didimo_logo_fingerprint.png differ diff --git a/docs/images/logo/didimo_logo_fingerprint.png.license b/docs/images/logo/didimo_logo_fingerprint.png.license new file mode 100644 index 0000000..2750c74 --- /dev/null +++ b/docs/images/logo/didimo_logo_fingerprint.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2024 Puria Nafisi Azizi +SPDX-FileCopyrightText: 2024 The Forkbomb Company + +SPDX-License-Identifier: CC-BY-NC-SA-4.0 diff --git a/docs/images/logo/didimo_logo_fingerprint_emblem.png b/docs/images/logo/didimo_logo_fingerprint_emblem.png new file mode 100644 index 0000000..77812db Binary files /dev/null and b/docs/images/logo/didimo_logo_fingerprint_emblem.png differ diff --git a/docs/images/logo/didimo_logo_fingerprint_emblem.png.license b/docs/images/logo/didimo_logo_fingerprint_emblem.png.license new file mode 100644 index 0000000..2750c74 --- /dev/null +++ b/docs/images/logo/didimo_logo_fingerprint_emblem.png.license @@ -0,0 +1,4 @@ +SPDX-FileCopyrightText: 2024 Puria Nafisi Azizi +SPDX-FileCopyrightText: 2024 The Forkbomb Company + +SPDX-License-Identifier: CC-BY-NC-SA-4.0 diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index fc5a2e2..0000000 --- a/docs/index.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Document - - - - - - -
- - - - - diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..21be720 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,29 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "DIDimo" + tagline: "Master the complexities of SSI identity solutions with DIDimo: Your go-to platform for testing, validating, and ensuring compliance in the ever-evolving digital identity ecosystem." + text: "Streamline identity compliance effortlessly." + image: + src: https://raw.githubusercontent.com/ForkbombEu/DIDimo/main/docs/images/logo/didimo_logo_fingerprint_emblem.png + actions: + - theme: brand + text: 🕹 Get started + link: /Architecture/1_start.html +# - theme: alt +# text: API Examples +# link: /api-examples + +features: + - title: Credential Issuer and Verifier Compliance Testing + details: Test OpenID4VCI and OpenID4VP services and applications for interoperability, with periodic scheduling debugging and report + - title: Developer Dashboard + details: developers can manage their services, view compliance statuses, schedule periodic checks, and access reports + - title: Plugin System for Extensibility + details: integration of additional checks and standards, enable third-party developers to contribute + - title: Marketplace + details: listing and comparison tool for end-users that allows them to browse and compare different digital identity products and services +--- + diff --git a/docs/index.ts b/docs/index.ts new file mode 100644 index 0000000..9d3aed9 --- /dev/null +++ b/docs/index.ts @@ -0,0 +1,5 @@ +// SPDX-FileCopyrightText: 2024 The Forkbomb Company +// +// SPDX-License-Identifier: AGPL-3.0-or-later + +console.log("Hello via Bun!"); \ No newline at end of file diff --git a/docs/organizations.md b/docs/organizations.md deleted file mode 100644 index dcf17fa..0000000 --- a/docs/organizations.md +++ /dev/null @@ -1,98 +0,0 @@ -# Organizations - -This docs page explain the information flows relative to: - -- `organization membership request` -- `organization invite` - -## User requests membership - -### Business logic - -- `🟢 user` sends membership request to `💾 pb` - - - `🖥️ ui` makes a `POST` to `api/collections/orgJoinRequests` - - `body`: `{organizationId: string, userId: string}` - -- This triggers a `hook` on `💾 pb` that sends an `✉️ email` to the `🧑‍💼 admins` - - - `hook`: `onRecordAfterCreateRequest` on `orgJoinRequests` collection. - -- `🧑‍💼 admins` from the `✉️ email`, are redirected to `🖥️ ui`: `/my/organizations/[id]/members` - -- `🧑‍💼 admins` in the `🖥️ ui` have two options: - - - accept invite - - send `POST` to `/api/collections/orgJoinRequests` - - `body`: `{status: "accepted"}` - - decline invite - - send `POST` to `/api/collections/orgJoinRequests` - - `body`: `{status: "declined"}` - -- `hook` on `💾 pb` sends a notification `✉️ email` to the `🟢 user` about the status change - - - `hook`: `onRecordAfterUpdateRequest` on `orgJoinRequests` collection - -### Relevant files - -- `admin/pb_hooks/organizations_request_membership.pb.js` -- `webapp/src/routes/[[lang]]/my/organizations/join/+page.svelte` -- `webapp/src/routes/[[lang]]/my/organizations/[id]/members/**/*` - -## Admin invites users - -### Business logic - -- `🧑‍💼 admins` invite `🟢 users` - - - `🖥️ ui` sends `POST` to `/organizations/invite` - - `body`: `{organizationId: string, emails: string[]}` - -- `💾 pb` handles the route: - - - `org_invite` `records` are created - - `✉️ email` is sent to `🟢 users` with `url` `/organization-invite-[orgId]-[inviteId]-[email]-[[userId]]` - - - `[[userId]]` is optional as `🟢 user` may be not registered on the platform - -- `🟢 user` clicks on the link in the `✉️ email` and is redirected to the `🖥️ ui` - -- `🖥️ ui` starts an `OrganizationInviteSession` (saved in sessionStorage) - -- Two things can happen now: - - - `Case A`: the `🟢 user` has already an `account` - - - `A.1`: is signed in - - (pass) - - `A.2`: is `not` signed in - - `redirect` to `/login` - - `🟢 user` completes login - - - `Case B`, the `🟢 user` is `not registered` - - - `redirect` to `/register` - - `🟢 user` completes registration - -- `🖥️ ui` ends the `OrganizationInviteSession` - -- `🖥️ ui` makes a `redirect` to `/my/organizations` - - - Invite is displayed on screen - -- `🟢 user` can now: - - - accept the invitation - - `POST` to `/organizations/invite/accept` - - `body`: `{inviteId:string}` - - decline the invitation - - `POST` to `/organizations/invite/decline` - - `body`: `{inviteId:string}` - -### Relevant files - -- `admin/pb_hooks/organizations_invites.pb.js` -- `webapp/src/routes/[[lang]]/(nru)/organization-invite-[orgId]-[inviteId]-[email]-[[userId]]/+page.ts` -- `webapp/src/routes/[[lang]]/my/+layout.ts` -- `webapp/src/routes/[[lang]]/my/organizations/+page.svelte` -- `webapp/src/routes/[[lang]]/my/organizations/[id]/members/+page.svelte` diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..1a1999e --- /dev/null +++ b/docs/package.json @@ -0,0 +1,20 @@ +{ + "name": "didimo-docs", + "module": "index.ts", + "type": "module", + "devDependencies": { + "@datagouv/vitepress-plugin-matomo": "^1.0.5", + "@types/bun": "latest", + "markdown-it-plantuml": "^1.4.1", + "vitepress": "^1.3.3", + "vitepress-sidebar": "^1.24.2" + }, + "peerDependencies": { + "typescript": "^5.0.0" + }, + "scripts": { + "docs:dev": "vitepress dev", + "docs:build": "vitepress build", + "docs:preview": "vitepress preview" + } +} \ No newline at end of file diff --git a/docs/package.json.license b/docs/package.json.license new file mode 100644 index 0000000..4abe685 --- /dev/null +++ b/docs/package.json.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2024 The Forkbomb Company + +SPDX-License-Identifier: AGPL-3.0-or-later diff --git a/docs/public/API/index.html b/docs/public/API/index.html new file mode 100644 index 0000000..a8d6258 --- /dev/null +++ b/docs/public/API/index.html @@ -0,0 +1,22 @@ + + + + + + + + + DIDimo 👀 Gateway API + + + + + + + + + diff --git a/docs/public/API/openapi.yml b/docs/public/API/openapi.yml new file mode 100644 index 0000000..49cbd80 --- /dev/null +++ b/docs/public/API/openapi.yml @@ -0,0 +1,1201 @@ +# SPDX-FileCopyrightText: 2024 The Forkbomb Company +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +openapi: 3.0.1 + +info: + title: DIDimo 👀 API Gateway + description: > + DIDimo API Gateway for managing EUDI-ARF compliance checks, periodic scheduling, organizational management, and reporting. + This API provides developers, service providers, and organizations with tools to ensure compliance, manage tests, reports, and ownership claims. + version: 1.4.0 + contact: + name: DIDimo Support + email: support@forkbomb.eu + url: https://forkbomb.solutions + +servers: + - url: https://s.api.didimo.forkbomb.eu/v1 + description: Staging server + - url: https://t.api.didimo.forkbomb.eu/v1 + description: Test server + +paths: + /auth/register: + post: + summary: Register a new user + description: > + Allows a new user to register with the system by providing necessary details. + The user will receive an access token upon successful registration. + tags: + - Authentication + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RegisterRequest' + responses: + '201': + description: User registered successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + '400': + description: Invalid registration data. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: User already exists. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error during registration. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /auth/login: + post: + summary: Log in user + description: > + Authenticates a user with their credentials and returns an access token if successful. + tags: + - Authentication + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/LoginRequest' + responses: + '200': + description: Login successful. Returns the access token. + content: + application/json: + schema: + $ref: '#/components/schemas/LoginResponse' + '401': + description: Invalid credentials. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error during login. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /compliance/score/{serviceId}: + get: + summary: Get the compliance score for a service + description: > + Retrieves the overall compliance score for a given service, which indicates how well the service adheres to + the standards it is measured against. + tags: + - Compliance + parameters: + - name: serviceId + in: path + required: true + schema: + type: string + description: The ID of the service for which the compliance score is being requested. + responses: + '200': + description: Successfully retrieved the compliance score. + content: + application/json: + schema: + $ref: '#/components/schemas/ComplianceScoreResponse' + '404': + description: Service not found with the provided ID. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while retrieving the compliance score. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /compliance/standards: + get: + summary: Get the list of available compliance standards + description: > + Fetches the list of all available compliance standards that services can be checked against. + Each standard contains information about its scope, version, and other relevant details. + tags: + - Compliance + responses: + '200': + description: Successfully retrieved the list of compliance standards. + content: + application/json: + schema: + $ref: '#/components/schemas/StandardsListResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while retrieving standards. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /compliance/check/{serviceId}/{standardId}: + get: + summary: Check the compliance of a service against a specific standard + description: > + Evaluates the compliance of a given service against a specified standard. + This returns detailed information on which aspects of the standard the service complies with + and which areas require improvement. + tags: + - Compliance + parameters: + - name: serviceId + in: path + required: true + schema: + type: string + description: The ID of the service being evaluated. + - name: standardId + in: path + required: true + schema: + type: string + description: The ID of the compliance standard being checked. + responses: + '200': + description: Successfully checked the service compliance against the specified standard. + content: + application/json: + schema: + $ref: '#/components/schemas/ComplianceCheckResponse' + '404': + description: > + Service or standard not found with the provided ID(s). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error during compliance check. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /tests: + post: + summary: Upload a new compliance test + description: > + Allows developers and service providers to upload new compliance tests to the platform. + Tests can be added via API to ensure they are executed as part of the compliance checks for credentials issuers. + tags: + - Tests + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TestSubmission' + responses: + '201': + description: Test uploaded successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + '400': + description: Invalid test data provided. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while processing the test upload. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /services: + post: + summary: Register a new service + description: > + Registers a new service under an organization. Services are associated with specific compliance checks and reports. + tags: + - Services + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceRegistration' + responses: + '201': + description: Service registered successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceResponse' + '400': + description: Invalid service data provided. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while registering the service. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + get: + summary: Retrieve all services + description: > + Retrieves a list of all registered services. Can be filtered by organization. + tags: + - Services + parameters: + - name: organizationId + in: query + schema: + type: string + description: Filter services by the given organization ID. + responses: + '200': + description: List of services retrieved successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ServicesListResponse' + '500': + description: Internal server error while retrieving services. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /services/{serviceId}: + get: + summary: Retrieve a specific service + description: > + Retrieves details about a specific service by its ID. + tags: + - Services + parameters: + - name: serviceId + in: path + required: true + schema: + type: string + description: The ID of the service to retrieve. + responses: + '200': + description: Service details retrieved successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceResponse' + '404': + description: Service not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while retrieving the service. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + summary: Delete a service + description: > + Deletes a service by its ID. Only authorized users with ownership rights can delete a service. + tags: + - Services + parameters: + - name: serviceId + in: path + required: true + schema: + type: string + description: The ID of the service to delete. + responses: + '200': + description: Service deleted successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + '404': + description: Service not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: User is not authorized to delete this service. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while deleting the service. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /schedule/compliance: + post: + summary: Schedule a compliance check + description: > + Schedules a compliance check for a specific service. Users can define the frequency (e.g., daily, weekly) + and set parameters for the compliance check. + tags: + - Scheduling + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleRequest' + responses: + '201': + description: Compliance check scheduled successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + '400': + description: Invalid scheduling data or missing parameters. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error during scheduling. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /schedule/compliance/{scheduleId}: + get: + summary: Retrieve the status of a compliance schedule + description: > + Fetches the status and details of a specific compliance schedule based on the schedule ID. + Users can see if their compliance check is pending, running, or completed. + tags: + - Scheduling + parameters: + - name: scheduleId + in: path + required: true + schema: + type: string + description: The unique ID of the compliance schedule. + responses: + '200': + description: Successfully retrieved the schedule status. + content: + application/json: + schema: + $ref: '#/components/schemas/ScheduleStatusResponse' + '404': + description: Schedule not found with the provided ID. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while retrieving the schedule. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + /reports: + get: + summary: Retrieve public reports + description: > + Retrieves a list of public reports that can be accessed without authentication. + tags: + - Reports + responses: + '200': + description: Public reports retrieved successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ReportsListResponse' + '500': + description: Internal server error while retrieving reports. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + summary: Submit a new report + description: > + Allows users to submit a new report for a specific service. If the user is not the owner, the report can still be submitted but requires approval. + tags: + - Reports + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ReportSubmission' + responses: + '201': + description: Report submitted successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ReportResponse' + '400': + description: Invalid report data provided. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while submitting the report. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /organizations: + post: + summary: Register a new organization + description: > + Allows a user to register a new organization. The user becomes the initial owner of the organization. + tags: + - Organizations + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OrganizationRequest' + responses: + '201': + description: Organization successfully registered. + content: + application/json: + schema: + $ref: '#/components/schemas/OrganizationResponse' + '400': + description: Invalid request body. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: Organization with the same name already exists. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while registering the organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /organizations/{organizationId}: + get: + summary: Retrieve organization details + description: > + Fetches details about a specific organization, including its services and members. + tags: + - Organizations + parameters: + - name: organizationId + in: path + required: true + schema: + type: string + description: The ID of the organization to retrieve. + responses: + '200': + description: Successfully retrieved organization details. + content: + application/json: + schema: + $ref: '#/components/schemas/OrganizationDetailsResponse' + '404': + description: Organization not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while retrieving organization details. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + put: + summary: Update organization details + description: > + Updates the information for an organization. Only owners or administrators can update organization details. + tags: + - Organizations + parameters: + - name: organizationId + in: path + required: true + schema: + type: string + description: The ID of the organization to update. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/OrganizationUpdateRequest' + responses: + '200': + description: Successfully updated organization details. + content: + application/json: + schema: + $ref: '#/components/schemas/OrganizationResponse' + '400': + description: Invalid request body. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Access denied; user does not have sufficient permissions. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Organization not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while updating the organization details. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /organizations/{organizationId}/services: + post: + summary: Add a service under an organization + description: > + Allows adding a new service under a specific organization. Only owners or administrators of the organization can perform this action. + tags: + - Organizations + parameters: + - name: organizationId + in: path + required: true + schema: + type: string + description: The ID of the organization to which the service is being added. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceRequest' + responses: + '201': + description: Service successfully added to the organization. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceResponse' + '400': + description: Invalid request body. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Access denied; user does not have sufficient permissions. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while adding the service. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /organizations/{organizationId}/users: + post: + summary: Add a user/owner to an organization + description: > + Adds a new user to the organization. Users can be added as members, administrators, or owners. + Only owners can add or manage other users within an organization. + tags: + - Organizations + parameters: + - name: organizationId + in: path + required: true + schema: + type: string + description: The ID of the organization to which the user is being added. + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserRoleRequest' + responses: + '201': + description: User successfully added to the organization. + content: + application/json: + schema: + $ref: '#/components/schemas/UserResponse' + '400': + description: Invalid request body. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '403': + description: Access denied; user does not have sufficient permissions. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while adding the user. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /organizations/{organizationId}/claim: + post: + summary: Claim ownership of an organization + description: > + Allows a user to request ownership of an organization. This claim will be subject to approval by current owners or administrators. + tags: + - Organizations + parameters: + - name: organizationId + in: path + required: true + schema: + type: string + description: The ID of the organization for which ownership is being claimed. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + userId: + type: string + description: The ID of the user making the claim. + responses: + '202': + description: Claim request submitted successfully and is pending approval. + content: + application/json: + schema: + $ref: '#/components/schemas/ClaimResponse' + '400': + description: Invalid request body. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '401': + description: Unauthorized access; valid authentication is required. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '404': + description: Organization not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '409': + description: An existing claim is already in process. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + '500': + description: Internal server error while processing the claim. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + +components: + schemas: + TestSubmission: + type: object + properties: + name: + type: string + description: The name of the test. + description: + type: string + description: A brief description of the test. + content: + type: string + format: base64 + description: The encoded test script/content. + required: + - name + - content + + ServiceRegistration: + type: object + properties: + name: + type: string + description: The name of the service. + organizationId: + type: string + description: The ID of the organization this service belongs to. + description: + type: string + description: A brief description of the service. + required: + - name + - organizationId + + ServiceResponse: + type: object + properties: + serviceId: + type: string + name: + type: string + organizationId: + type: string + description: + type: string + + ServicesListResponse: + type: object + properties: + services: + type: array + items: + $ref: '#/components/schemas/ServiceResponse' + total: + type: integer + + ReportSubmission: + type: object + properties: + serviceId: + type: string + status: + type: string + enum: [COMPLIANT, NON_COMPLIANT, PENDING] + details: + type: array + items: + type: string + isPublic: + type: boolean + required: + - serviceId + - status + + ReportResponse: + type: object + properties: + reportId: + type: string + message: + type: string + + ReportsListResponse: + type: object + properties: + reports: + type: array + items: + $ref: '#/components/schemas/Report' + total: + type: integer + + SuccessResponse: + type: object + properties: + status: + type: string + example: "OK" + code: + type: integer + example: 200 + message: + type: string + example: "Operation completed successfully." + + ErrorResponse: + type: object + properties: + status: + type: string + example: "ERROR" + code: + type: integer + example: 400 + message: + type: string + example: "Bad Request" + errors: + type: array + items: + type: string + + RegisterRequest: + type: object + properties: + username: + type: string + description: The username of the user to register. + password: + type: string + format: password + description: The password for the user. + email: + type: string + format: email + description: The email address of the user. + required: + - username + - password + - email + + LoginRequest: + type: object + properties: + username: + type: string + description: The username of the user. + password: + type: string + format: password + description: The password for the user. + required: + - username + - password + + LoginResponse: + type: object + properties: + data: + type: object + properties: + accessToken: + type: string + description: The JWT access token for the authenticated user. + refreshToken: + type: string + description: The refresh token used to generate new access tokens. + ScheduleRequest: + type: object + properties: + serviceId: + type: string + description: The ID of the service for which the compliance check is scheduled. + frequency: + type: string + enum: [daily, weekly, monthly] + description: The frequency of the compliance check. + startDate: + type: string + format: date-time + description: The date and time when the first compliance check should be executed. + parameters: + type: object + additionalProperties: + type: string + description: Additional parameters for the compliance check. + required: + - serviceId + - frequency + - startDate + + ScheduleStatusResponse: + type: object + properties: + data: + type: object + properties: + scheduleId: + type: string + description: The ID of the compliance schedule. + status: + type: string + enum: [pending, running, completed, failed] + description: The current status of the compliance check. + nextRun: + type: string + format: date-time + description: The next scheduled execution time for the compliance check. + lastRun: + type: string + format: date-time + description: The last time the compliance check was executed. + resultsSummary: + type: object + properties: + successCount: + type: integer + description: The number of successful checks. + failureCount: + type: integer + description: The number of failed checks. + lastOutcome: + type: string + description: The outcome of the most recent compliance check. + required: + - scheduleId + - status + + ComplianceScoreResponse: + type: object + properties: + data: + type: object + properties: + serviceId: + type: string + description: The ID of the service for which the compliance score is being reported. + score: + type: number + format: float + description: The overall compliance score of the service (0.0 to 1.0, where 1.0 is fully compliant). + standardsComplied: + type: array + items: + type: string + description: A list of standard IDs the service complies with. + standardsPending: + type: array + items: + type: string + description: A list of standard IDs the service does not yet comply with. + required: + - serviceId + - score + + StandardsListResponse: + type: object + properties: + data: + type: array + items: + type: object + properties: + standardId: + type: string + description: The unique ID of the compliance standard. + name: + type: string + description: The name of the compliance standard. + version: + type: string + description: The version of the standard. + description: + type: string + description: A brief description of the compliance standard. + lastUpdated: + type: string + format: date-time + description: The date when the standard was last updated. + required: + - data + + ComplianceCheckResponse: + type: object + properties: + data: + type: object + properties: + serviceId: + type: string + description: The ID of the service being checked. + standardId: + type: string + description: The ID of the compliance standard being evaluated. + complianceStatus: + type: string + enum: [compliant, non-compliant, partially-compliant] + description: The compliance status of the service against the specified standard. + complianceDetails: + type: object + properties: + passedCriteria: + type: array + items: + type: string + description: A list of criteria that the service passed. + failedCriteria: + type: array + items: + type: string + description: A list of criteria that the service failed to meet. + recommendations: + type: array + items: + type: string + description: Suggested actions to achieve compliance. + required: + - serviceId + - standardId + - complianceStatus + + OrganizationRequest: + type: object + properties: + name: + type: string + description: The name of the organization. + description: + type: string + description: A brief description of the organization. + required: + - name + + OrganizationResponse: + type: object + properties: + data: + type: object + properties: + organizationId: + type: string + name: + type: string + description: + type: string + nullable: true + + OrganizationUpdateRequest: + type: object + properties: + name: + type: string + description: + type: string + + ServiceRequest: + type: object + properties: + name: + type: string + description: The name of the service being added. + details: + type: string + description: Additional information about the service. + + UserRoleRequest: + type: object + properties: + userId: + type: string + role: + type: string + enum: [member, administrator, owner] + description: The role assigned to the user within the organization. + required: + - userId + - role diff --git a/docs/public/API/pdf.html b/docs/public/API/pdf.html new file mode 100644 index 0000000..c7f6d1d --- /dev/null +++ b/docs/public/API/pdf.html @@ -0,0 +1,13 @@ + + + + + + + + + + diff --git a/docs/sw_arch.md b/docs/sw_arch.md deleted file mode 100644 index 36987c2..0000000 --- a/docs/sw_arch.md +++ /dev/null @@ -1,991 +0,0 @@ - -# - -**About arc42** - -arc42, the template for documentation of software and system -architecture. - -Template Version 8.2 EN. (based upon AsciiDoc version), January 2023 - -Created, maintained and © by Dr. Peter Hruschka, Dr. Gernot Starke and -contributors. See . - -> **_note_** This version of the template contains some help and explanations. It is - used for familiarization with arc42 and the understanding of the - concepts. For documentation of your own system you use better the - *plain* version. - - -# Introduction and Goals {#section-introduction-and-goals} - -Describes the relevant requirements and the driving forces that software -architects and development team must consider. These include - -- underlying business goals, - -- essential features, - -- essential functional requirements, - -- quality goals for the architecture and - -- relevant stakeholders and their expectations - -## Requirements Overview {#_requirements_overview} - - -**Contents** - - -Short description of the functional requirements, driving forces, -extract (or abstract) of requirements. Link to (hopefully existing) -requirements documents (with version number and information where to -find it). - - -**Motivation** - - -From the point of view of the end users a system is created or modified -to improve support of a business activity and/or improve the quality. - - -**Form** - - -Short textual description, probably in tabular use-case format. If -requirements documents exist this overview should refer to these -documents. - -Keep these excerpts as short as possible. Balance readability of this -document with potential redundancy w.r.t to requirements documents. - -See [Introduction and Goals](https://docs.arc42.org/section-1/) in the -arc42 documentation. - -## Quality Goals {#_quality_goals} - - -**Contents** - - -The top three (max five) quality goals for the architecture whose -fulfillment is of highest importance to the major stakeholders. We -really mean quality goals for the architecture. Don't confuse them with -project goals. They are not necessarily identical. - -Consider this overview of potential topics (based upon the ISO 25010 -standard): - -![Categories of Quality -Requirements](images/01_2_iso-25010-topics-EN.drawio.png) - - -**Motivation** - - -You should know the quality goals of your most important stakeholders, -since they will influence fundamental architectural decisions. Make sure -to be very concrete about these qualities, avoid buzzwords. If you as an -architect do not know how the quality of your work will be judged... - - -**Form** - - -A table with quality goals and concrete scenarios, ordered by priorities - -## Stakeholders {#_stakeholders} - - -**Contents** - - -Explicit overview of stakeholders of the system, i.e. all person, roles -or organizations that - -- should know the architecture - -- have to be convinced of the architecture - -- have to work with the architecture or with code - -- need the documentation of the architecture for their work - -- have to come up with decisions about the system or its development - - -**Motivation** - - -You should know all parties involved in development of the system or -affected by the system. Otherwise, you may get nasty surprises later in -the development process. These stakeholders determine the extent and the -level of detail of your work and its results. - - -**Form** - - -Table with role names, person names, and their expectations with respect -to the architecture and its documentation. - -+-------------+---------------------------+---------------------------+ -| Role/Name | Contact | Expectations | -+=============+===========================+===========================+ -| *\* | *\* | *\* | -+-------------+---------------------------+---------------------------+ -| *\* | *\* | *\* | -+-------------+---------------------------+---------------------------+ - -# Architecture Constraints {#section-architecture-constraints} - - -**Contents** - - -Any requirement that constraints software architects in their freedom of -design and implementation decisions or decision about the development -process. These constraints sometimes go beyond individual systems and -are valid for whole organizations and companies. - - -**Motivation** - - -Architects should know exactly where they are free in their design -decisions and where they must adhere to constraints. Constraints must -always be dealt with; they may be negotiable, though. - - -**Form** - - -Simple tables of constraints with explanations. If needed you can -subdivide them into technical constraints, organizational and political -constraints and conventions (e.g. programming or versioning guidelines, -documentation or naming conventions) - -See [Architecture Constraints](https://docs.arc42.org/section-2/) in the -arc42 documentation. - -# System Scope and Context {#section-system-scope-and-context} - - -**Contents** - - -System scope and context - as the name suggests - delimits your system -(i.e. your scope) from all its communication partners (neighboring -systems and users, i.e. the context of your system). It thereby -specifies the external interfaces. - -If necessary, differentiate the business context (domain specific inputs -and outputs) from the technical context (channels, protocols, hardware). - - -**Motivation** - - -The domain interfaces and technical interfaces to communication partners -are among your system's most critical aspects. Make sure that you -completely understand them. - - -**Form** - - -Various options: - -- Context diagrams - -- Lists of communication partners and their interfaces. - -See [Context and Scope](https://docs.arc42.org/section-3/) in the arc42 -documentation. - -## Business Context {#_business_context} - - -**Contents** - - -Specification of **all** communication partners (users, IT-systems, ...) -with explanations of domain specific inputs and outputs or interfaces. -Optionally you can add domain specific formats or communication -protocols. - - -**Motivation** - - -All stakeholders should understand which data are exchanged with the -environment of the system. - - -**Form** - - -All kinds of diagrams that show the system as a black box and specify -the domain interfaces to communication partners. - -Alternatively (or additionally) you can use a table. The title of the -table is the name of your system, the three columns contain the name of -the communication partner, the inputs, and the outputs. - -**\** - -**\** - -## Technical Context {#_technical_context} - - -**Contents** - - -Technical interfaces (channels and transmission media) linking your -system to its environment. In addition a mapping of domain specific -input/output to the channels, i.e. an explanation which I/O uses which -channel. - - -**Motivation** - - -Many stakeholders make architectural decision based on the technical -interfaces between the system and its context. Especially infrastructure -or hardware designers decide these technical interfaces. - - -**Form** - - -E.g. UML deployment diagram describing channels to neighboring systems, -together with a mapping table showing the relationships between channels -and input/output. - -**\** - -**\** - -**\** - -# Solution Strategy {#section-solution-strategy} - - -**Contents** - - -A short summary and explanation of the fundamental decisions and -solution strategies, that shape system architecture. It includes - -- technology decisions - -- decisions about the top-level decomposition of the system, e.g. - usage of an architectural pattern or design pattern - -- decisions on how to achieve key quality goals - -- relevant organizational decisions, e.g. selecting a development - process or delegating certain tasks to third parties. - - -**Motivation** - - -These decisions form the cornerstones for your architecture. They are -the foundation for many other detailed decisions or implementation -rules. - - -**Form** - - -Keep the explanations of such key decisions short. - -Motivate what was decided and why it was decided that way, based upon -problem statement, quality goals and key constraints. Refer to details -in the following sections. - -See [Solution Strategy](https://docs.arc42.org/section-4/) in the arc42 -documentation. - -# Building Block View {#section-building-block-view} - - -**Content** - - -The building block view shows the static decomposition of the system -into building blocks (modules, components, subsystems, classes, -interfaces, packages, libraries, frameworks, layers, partitions, tiers, -functions, macros, operations, data structures, ...) as well as their -dependencies (relationships, associations, ...) - -This view is mandatory for every architecture documentation. In analogy -to a house this is the *floor plan*. - - -**Motivation** - - -Maintain an overview of your source code by making its structure -understandable through abstraction. - -This allows you to communicate with your stakeholder on an abstract -level without disclosing implementation details. - - -**Form** - - -The building block view is a hierarchical collection of black boxes and -white boxes (see figure below) and their descriptions. - -![Hierarchy of building blocks](images/05_building_blocks-EN.png) - -**Level 1** is the white box description of the overall system together -with black box descriptions of all contained building blocks. - -**Level 2** zooms into some building blocks of level 1. Thus it contains -the white box description of selected building blocks of level 1, -together with black box descriptions of their internal building blocks. - -**Level 3** zooms into selected building blocks of level 2, and so on. - -See [Building Block View](https://docs.arc42.org/section-5/) in the -arc42 documentation. - -## Whitebox Overall System {#_whitebox_overall_system} - -Here you describe the decomposition of the overall system using the -following white box template. It contains - -- an overview diagram - -- a motivation for the decomposition - -- black box descriptions of the contained building blocks. For these - we offer you alternatives: - - - use *one* table for a short and pragmatic overview of all - contained building blocks and their interfaces - - - use a list of black box descriptions of the building blocks - according to the black box template (see below). Depending on - your choice of tool this list could be sub-chapters (in text - files), sub-pages (in a Wiki) or nested elements (in a modeling - tool). - -- (optional:) important interfaces, that are not explained in the - black box templates of a building block, but are very important for - understanding the white box. Since there are so many ways to specify - interfaces why do not provide a specific template for them. In the - worst case you have to specify and describe syntax, semantics, - protocols, error handling, restrictions, versions, qualities, - necessary compatibilities and many things more. In the best case you - will get away with examples or simple signatures. - -***\*** - -Motivation - -: *\* - -Contained Building Blocks - -: *\* - -Important Interfaces - -: *\* - -Insert your explanations of black boxes from level 1: - -If you use tabular form you will only describe your black boxes with -name and responsibility according to the following schema: - -+-----------------------+-----------------------------------------------+ -| **Name** | **Responsibility** | -+=======================+===============================================+ -| *\* |  *\* | -+-----------------------+-----------------------------------------------+ -| *\* |  *\* | -+-----------------------+-----------------------------------------------+ - -If you use a list of black box descriptions then you fill in a separate -black box template for every important building block . Its headline is -the name of the black box. - -### \ {#__name_black_box_1} - -Here you describe \ according the the following black box -template: - -- Purpose/Responsibility - -- Interface(s), when they are not extracted as separate paragraphs. - This interfaces may include qualities and performance - characteristics. - -- (Optional) Quality-/Performance characteristics of the black box, - e.g.availability, run time behavior, .... - -- (Optional) directory/file location - -- (Optional) Fulfilled requirements (if you need traceability to - requirements). - -- (Optional) Open issues/problems/risks - -*\* - -*\* - -*\<(Optional) Quality/Performance Characteristics>* - -*\<(Optional) Directory/File Location>* - -*\<(Optional) Fulfilled Requirements>* - -*\<(optional) Open Issues/Problems/Risks>* - -### \ {#__name_black_box_2} - -*\* - -### \ {#__name_black_box_n} - -*\* - -### \ {#__name_interface_1} - -... - -### \ {#__name_interface_m} - -## Level 2 {#_level_2} - -Here you can specify the inner structure of (some) building blocks from -level 1 as white boxes. - -You have to decide which building blocks of your system are important -enough to justify such a detailed description. Please prefer relevance -over completeness. Specify important, surprising, risky, complex or -volatile building blocks. Leave out normal, simple, boring or -standardized parts of your system - -### White Box *\* {#_white_box_emphasis_building_block_1_emphasis} - -...describes the internal structure of *building block 1*. - -*\* - -### White Box *\* {#_white_box_emphasis_building_block_2_emphasis} - -*\* - -... - -### White Box *\* {#_white_box_emphasis_building_block_m_emphasis} - -*\* - -## Level 3 {#_level_3} - -Here you can specify the inner structure of (some) building blocks from -level 2 as white boxes. - -When you need more detailed levels of your architecture please copy this -part of arc42 for additional levels. - -### White Box \<\_building block x.1\_\> {#_white_box_building_block_x_1} - -Specifies the internal structure of *building block x.1*. - -*\* - -### White Box \<\_building block x.2\_\> {#_white_box_building_block_x_2} - -*\* - -### White Box \<\_building block y.1\_\> {#_white_box_building_block_y_1} - -*\* - -# Runtime View {#section-runtime-view} - - -**Contents** - - -The runtime view describes concrete behavior and interactions of the -system's building blocks in form of scenarios from the following areas: - -- important use cases or features: how do building blocks execute - them? - -- interactions at critical external interfaces: how do building blocks - cooperate with users and neighboring systems? - -- operation and administration: launch, start-up, stop - -- error and exception scenarios - -Remark: The main criterion for the choice of possible scenarios -(sequences, workflows) is their **architectural relevance**. It is -**not** important to describe a large number of scenarios. You should -rather document a representative selection. - - -**Motivation** - - -You should understand how (instances of) building blocks of your system -perform their job and communicate at runtime. You will mainly capture -scenarios in your documentation to communicate your architecture to -stakeholders that are less willing or able to read and understand the -static models (building block view, deployment view). - - -**Form** - - -There are many notations for describing scenarios, e.g. - -- numbered list of steps (in natural language) - -- activity diagrams or flow charts - -- sequence diagrams - -- BPMN or EPCs (event process chains) - -- state machines - -- ... - -See [Runtime View](https://docs.arc42.org/section-6/) in the arc42 -documentation. - -## \ {#__runtime_scenario_1} - -- *\* - -- *\* - -## \ {#__runtime_scenario_2} - -## ... {#_} - -## \ {#__runtime_scenario_n} - -# Deployment View {#section-deployment-view} - - -**Content** - - -The deployment view describes: - -1. technical infrastructure used to execute your system, with - infrastructure elements like geographical locations, environments, - computers, processors, channels and net topologies as well as other - infrastructure elements and - -2. mapping of (software) building blocks to that infrastructure - elements. - -Often systems are executed in different environments, e.g. development -environment, test environment, production environment. In such cases you -should document all relevant environments. - -Especially document a deployment view if your software is executed as -distributed system with more than one computer, processor, server or -container or when you design and construct your own hardware processors -and chips. - -From a software perspective it is sufficient to capture only those -elements of an infrastructure that are needed to show a deployment of -your building blocks. Hardware architects can go beyond that and -describe an infrastructure to any level of detail they need to capture. - - -**Motivation** - - -Software does not run without hardware. This underlying infrastructure -can and will influence a system and/or some cross-cutting concepts. -Therefore, there is a need to know the infrastructure. - -Maybe a highest level deployment diagram is already contained in section -3.2. as technical context with your own infrastructure as ONE black box. -In this section one can zoom into this black box using additional -deployment diagrams: - -- UML offers deployment diagrams to express that view. Use it, - probably with nested diagrams, when your infrastructure is more - complex. - -- When your (hardware) stakeholders prefer other kinds of diagrams - rather than a deployment diagram, let them use any kind that is able - to show nodes and channels of the infrastructure. - -See [Deployment View](https://docs.arc42.org/section-7/) in the arc42 -documentation. - -## Infrastructure Level 1 {#_infrastructure_level_1} - -Describe (usually in a combination of diagrams, tables, and text): - -- distribution of a system to multiple locations, environments, - computers, processors, .., as well as physical connections between - them - -- important justifications or motivations for this deployment - structure - -- quality and/or performance features of this infrastructure - -- mapping of software artifacts to elements of this infrastructure - -For multiple environments or alternative deployments please copy and -adapt this section of arc42 for all relevant environments. - -***\*** - -Motivation - -: *\* - -Quality and/or Performance Features - -: *\* - -Mapping of Building Blocks to Infrastructure - -: *\* - -## Infrastructure Level 2 {#_infrastructure_level_2} - -Here you can include the internal structure of (some) infrastructure -elements from level 1. - -Please copy the structure from level 1 for each selected element. - -### *\* {#__emphasis_infrastructure_element_1_emphasis} - -*\* - -### *\* {#__emphasis_infrastructure_element_2_emphasis} - -*\* - -... - -### *\* {#__emphasis_infrastructure_element_n_emphasis} - -*\* - -# Cross-cutting Concepts {#section-concepts} - - -**Content** - - -This section describes overall, principal regulations and solution ideas -that are relevant in multiple parts (= cross-cutting) of your system. -Such concepts are often related to multiple building blocks. They can -include many different topics, such as - -- models, especially domain models - -- architecture or design patterns - -- rules for using specific technology - -- principal, often technical decisions of an overarching (= - cross-cutting) nature - -- implementation rules - - -**Motivation** - - -Concepts form the basis for *conceptual integrity* (consistency, -homogeneity) of the architecture. Thus, they are an important -contribution to achieve inner qualities of your system. - -Some of these concepts cannot be assigned to individual building blocks, -e.g. security or safety. - - -**Form** - - -The form can be varied: - -- concept papers with any kind of structure - -- cross-cutting model excerpts or scenarios using notations of the - architecture views - -- sample implementations, especially for technical concepts - -- reference to typical usage of standard frameworks (e.g. using - Hibernate for object/relational mapping) - - -**Structure** - - -A potential (but not mandatory) structure for this section could be: - -- Domain concepts - -- User Experience concepts (UX) - -- Safety and security concepts - -- Architecture and design patterns - -- \"Under-the-hood\" - -- development concepts - -- operational concepts - -Note: it might be difficult to assign individual concepts to one -specific topic on this list. - -![Possible topics for crosscutting -concepts](images/08-Crosscutting-Concepts-Structure-EN.png) - -See [Concepts](https://docs.arc42.org/section-8/) in the arc42 -documentation. - -## *\* {#__emphasis_concept_1_emphasis} - -*\* - -## *\* {#__emphasis_concept_2_emphasis} - -*\* - -... - -## *\* {#__emphasis_concept_n_emphasis} - -*\* - -# Architecture Decisions {#section-design-decisions} - - -**Contents** - - -Important, expensive, large scale or risky architecture decisions -including rationales. With \"decisions\" we mean selecting one -alternative based on given criteria. - -Please use your judgement to decide whether an architectural decision -should be documented here in this central section or whether you better -document it locally (e.g. within the white box template of one building -block). - -Avoid redundancy. Refer to section 4, where you already captured the -most important decisions of your architecture. - - -**Motivation** - - -Stakeholders of your system should be able to comprehend and retrace -your decisions. - - -**Form** - - -Various options: - -- ADR ([Documenting Architecture - Decisions](https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions)) - for every important decision - -- List or table, ordered by importance and consequences or: - -- more detailed in form of separate sections per decision - -See [Architecture Decisions](https://docs.arc42.org/section-9/) in the -arc42 documentation. There you will find links and examples about ADR. - -# Quality Requirements {#section-quality-scenarios} - - -**Content** - - -This section contains all quality requirements as quality tree with -scenarios. The most important ones have already been described in -section 1.2. (quality goals) - -Here you can also capture quality requirements with lesser priority, -which will not create high risks when they are not fully achieved. - - -**Motivation** - - -Since quality requirements will have a lot of influence on architectural -decisions you should know for every stakeholder what is really important -to them, concrete and measurable. - -See [Quality Requirements](https://docs.arc42.org/section-10/) in the -arc42 documentation. - -## Quality Tree {#_quality_tree} - - -**Content** - - -The quality tree (as defined in ATAM -- Architecture Tradeoff Analysis -Method) with quality/evaluation scenarios as leafs. - - -**Motivation** - - -The tree structure with priorities provides an overview for a sometimes -large number of quality requirements. - - -**Form** - - -The quality tree is a high-level overview of the quality goals and -requirements: - -- tree-like refinement of the term \"quality\". Use \"quality\" or - \"usefulness\" as a root - -- a mind map with quality categories as main branches - -In any case the tree should include links to the scenarios of the -following section. - -## Quality Scenarios {#_quality_scenarios} - - -**Contents** - - -Concretization of (sometimes vague or implicit) quality requirements -using (quality) scenarios. - -These scenarios describe what should happen when a stimulus arrives at -the system. - -For architects, two kinds of scenarios are important: - -- Usage scenarios (also called application scenarios or use case - scenarios) describe the system's runtime reaction to a certain - stimulus. This also includes scenarios that describe the system's - efficiency or performance. Example: The system reacts to a user's - request within one second. - -- Change scenarios describe a modification of the system or of its - immediate environment. Example: Additional functionality is - implemented or requirements for a quality attribute change. - - -**Motivation** - - -Scenarios make quality requirements concrete and allow to more easily -measure or decide whether they are fulfilled. - -Especially when you want to assess your architecture using methods like -ATAM you need to describe your quality goals (from section 1.2) more -precisely down to a level of scenarios that can be discussed and -evaluated. - - -**Form** - - -Tabular or free form text. - -# Risks and Technical Debts {#section-technical-risks} - - -**Contents** - - -A list of identified technical risks or technical debts, ordered by -priority - - -**Motivation** - - -"Risk management is project management for grown-ups" (Tim Lister, -Atlantic Systems Guild.) - -This should be your motto for systematic detection and evaluation of -risks and technical debts in the architecture, which will be needed by -management stakeholders (e.g. project managers, product owners) as part -of the overall risk analysis and measurement planning. - - -**Form** - - -List of risks and/or technical debts, probably including suggested -measures to minimize, mitigate or avoid risks or reduce technical debts. - -See [Risks and Technical Debt](https://docs.arc42.org/section-11/) in -the arc42 documentation. - -# Glossary {#section-glossary} - - -**Contents** - - -The most important domain and technical terms that your stakeholders use -when discussing the system. - -You can also see the glossary as source for translations if you work in -multi-language teams. - - -**Motivation** - - -You should clearly define your terms, so that all stakeholders - -- have an identical understanding of these terms - -- do not use synonyms and homonyms - -A table with columns \ and \. - -Potentially more columns in case you need translations. - -See [Glossary](https://docs.arc42.org/section-12/) in the arc42 -documentation. - -+-----------------------+-----------------------------------------------+ -| Term | Definition | -+=======================+===============================================+ -| *\* | *\* | -+-----------------------+-----------------------------------------------+ -| *\* | *\* | -+-----------------------+-----------------------------------------------+ - - diff --git a/docs/tsconfig.json b/docs/tsconfig.json new file mode 100644 index 0000000..238655f --- /dev/null +++ b/docs/tsconfig.json @@ -0,0 +1,27 @@ +{ + "compilerOptions": { + // Enable latest features + "lib": ["ESNext", "DOM"], + "target": "ESNext", + "module": "ESNext", + "moduleDetection": "force", + "jsx": "react-jsx", + "allowJs": true, + + // Bundler mode + "moduleResolution": "bundler", + "allowImportingTsExtensions": true, + "verbatimModuleSyntax": true, + "noEmit": true, + + // Best practices + "strict": true, + "skipLibCheck": true, + "noFallthroughCasesInSwitch": true, + + // Some stricter flags (disabled by default) + "noUnusedLocals": false, + "noUnusedParameters": false, + "noPropertyAccessFromIndexSignature": false + } +} diff --git a/docs/tsconfig.json.license b/docs/tsconfig.json.license new file mode 100644 index 0000000..4abe685 --- /dev/null +++ b/docs/tsconfig.json.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2024 The Forkbomb Company + +SPDX-License-Identifier: AGPL-3.0-or-later diff --git a/admin/examples/createUser.mjs b/examples/createUser.mjs similarity index 100% rename from admin/examples/createUser.mjs rename to examples/createUser.mjs diff --git a/admin/examples/package.json b/examples/package.json similarity index 100% rename from admin/examples/package.json rename to examples/package.json diff --git a/admin/examples/yarn.lock b/examples/yarn.lock similarity index 100% rename from admin/examples/yarn.lock rename to examples/yarn.lock diff --git a/admin/go.mod b/go.mod similarity index 100% rename from admin/go.mod rename to go.mod diff --git a/admin/go.sum b/go.sum similarity index 100% rename from admin/go.sum rename to go.sum diff --git a/admin/hooks/hooks.go b/hooks/hooks.go similarity index 100% rename from admin/hooks/hooks.go rename to hooks/hooks.go diff --git a/admin/hooks/hooks_test.go b/hooks/hooks_test.go similarity index 100% rename from admin/hooks/hooks_test.go rename to hooks/hooks_test.go diff --git a/admin/main.go b/main.go similarity index 100% rename from admin/main.go rename to main.go diff --git a/admin/migrations/1664858353_collections_snapshot.go b/migrations/1664858353_collections_snapshot.go similarity index 100% rename from admin/migrations/1664858353_collections_snapshot.go rename to migrations/1664858353_collections_snapshot.go diff --git a/admin/pb_hooks/ambient.d.ts b/pb_hooks/ambient.d.ts similarity index 100% rename from admin/pb_hooks/ambient.d.ts rename to pb_hooks/ambient.d.ts diff --git a/admin/pb_hooks/auditLogger.js b/pb_hooks/auditLogger.js similarity index 100% rename from admin/pb_hooks/auditLogger.js rename to pb_hooks/auditLogger.js diff --git a/admin/pb_hooks/features.pb.js b/pb_hooks/features.pb.js similarity index 100% rename from admin/pb_hooks/features.pb.js rename to pb_hooks/features.pb.js diff --git a/admin/pb_hooks/oauth.pb.js b/pb_hooks/oauth.pb.js similarity index 100% rename from admin/pb_hooks/oauth.pb.js rename to pb_hooks/oauth.pb.js diff --git a/admin/pb_hooks/organizations.pb.js b/pb_hooks/organizations.pb.js similarity index 100% rename from admin/pb_hooks/organizations.pb.js rename to pb_hooks/organizations.pb.js diff --git a/admin/pb_hooks/organizations_authorizations.pb.js b/pb_hooks/organizations_authorizations.pb.js similarity index 100% rename from admin/pb_hooks/organizations_authorizations.pb.js rename to pb_hooks/organizations_authorizations.pb.js diff --git a/admin/pb_hooks/organizations_invites.pb.js b/pb_hooks/organizations_invites.pb.js similarity index 100% rename from admin/pb_hooks/organizations_invites.pb.js rename to pb_hooks/organizations_invites.pb.js diff --git a/admin/pb_hooks/organizations_request_membership.pb.js b/pb_hooks/organizations_request_membership.pb.js similarity index 100% rename from admin/pb_hooks/organizations_request_membership.pb.js rename to pb_hooks/organizations_request_membership.pb.js diff --git a/admin/pb_hooks/users.pb.js b/pb_hooks/users.pb.js similarity index 100% rename from admin/pb_hooks/users.pb.js rename to pb_hooks/users.pb.js diff --git a/admin/pb_hooks/utils.js b/pb_hooks/utils.js similarity index 100% rename from admin/pb_hooks/utils.js rename to pb_hooks/utils.js diff --git a/admin/pb_migrations/1681363155_collections_snapshot.js b/pb_migrations/1681363155_collections_snapshot.js similarity index 100% rename from admin/pb_migrations/1681363155_collections_snapshot.js rename to pb_migrations/1681363155_collections_snapshot.js diff --git a/admin/pb_migrations/1685000000_create_admin.js b/pb_migrations/1685000000_create_admin.js similarity index 100% rename from admin/pb_migrations/1685000000_create_admin.js rename to pb_migrations/1685000000_create_admin.js diff --git a/admin/pb_migrations/1685000000_initial_settings.js b/pb_migrations/1685000000_initial_settings.js similarity index 100% rename from admin/pb_migrations/1685000000_initial_settings.js rename to pb_migrations/1685000000_initial_settings.js diff --git a/admin/pb_migrations/1685000000_seed_features.js b/pb_migrations/1685000000_seed_features.js similarity index 100% rename from admin/pb_migrations/1685000000_seed_features.js rename to pb_migrations/1685000000_seed_features.js diff --git a/admin/pb_migrations/1685000001_seed_users.js b/pb_migrations/1685000001_seed_users.js similarity index 100% rename from admin/pb_migrations/1685000001_seed_users.js rename to pb_migrations/1685000001_seed_users.js diff --git a/admin/pb_migrations/1689062410_updated_hooks.js b/pb_migrations/1689062410_updated_hooks.js similarity index 100% rename from admin/pb_migrations/1689062410_updated_hooks.js rename to pb_migrations/1689062410_updated_hooks.js diff --git a/admin/pb_migrations/1689094917_updated_users.js b/pb_migrations/1689094917_updated_users.js similarity index 100% rename from admin/pb_migrations/1689094917_updated_users.js rename to pb_migrations/1689094917_updated_users.js diff --git a/admin/pb_migrations/1689097267_updated_authorizationsExamples.js b/pb_migrations/1689097267_updated_authorizationsExamples.js similarity index 100% rename from admin/pb_migrations/1689097267_updated_authorizationsExamples.js rename to pb_migrations/1689097267_updated_authorizationsExamples.js diff --git a/admin/pb_migrations/1689097291_updated_authorizations.js b/pb_migrations/1689097291_updated_authorizations.js similarity index 100% rename from admin/pb_migrations/1689097291_updated_authorizations.js rename to pb_migrations/1689097291_updated_authorizations.js diff --git a/admin/pb_migrations/1689155439_updated_authorizationsExamples.js b/pb_migrations/1689155439_updated_authorizationsExamples.js similarity index 100% rename from admin/pb_migrations/1689155439_updated_authorizationsExamples.js rename to pb_migrations/1689155439_updated_authorizationsExamples.js diff --git a/admin/pb_migrations/1692027564_updated_hooks.js b/pb_migrations/1692027564_updated_hooks.js similarity index 100% rename from admin/pb_migrations/1692027564_updated_hooks.js rename to pb_migrations/1692027564_updated_hooks.js diff --git a/admin/pb_migrations/1692194881_created_sessionDataWebauthn.js b/pb_migrations/1692194881_created_sessionDataWebauthn.js similarity index 100% rename from admin/pb_migrations/1692194881_created_sessionDataWebauthn.js rename to pb_migrations/1692194881_created_sessionDataWebauthn.js diff --git a/admin/pb_migrations/1692626405_created_webauthnCredentials.js b/pb_migrations/1692626405_created_webauthnCredentials.js similarity index 100% rename from admin/pb_migrations/1692626405_created_webauthnCredentials.js rename to pb_migrations/1692626405_created_webauthnCredentials.js diff --git a/admin/pb_migrations/1692700573_updated_webauthnCredentials.js b/pb_migrations/1692700573_updated_webauthnCredentials.js similarity index 100% rename from admin/pb_migrations/1692700573_updated_webauthnCredentials.js rename to pb_migrations/1692700573_updated_webauthnCredentials.js diff --git a/admin/pb_migrations/1692700709_updated_webauthnCredentials.js b/pb_migrations/1692700709_updated_webauthnCredentials.js similarity index 100% rename from admin/pb_migrations/1692700709_updated_webauthnCredentials.js rename to pb_migrations/1692700709_updated_webauthnCredentials.js diff --git a/admin/pb_migrations/1692796632_updated_webauthnCredentials.js b/pb_migrations/1692796632_updated_webauthnCredentials.js similarity index 100% rename from admin/pb_migrations/1692796632_updated_webauthnCredentials.js rename to pb_migrations/1692796632_updated_webauthnCredentials.js diff --git a/admin/pb_migrations/1694441090_updated_webauthnCredentials.js b/pb_migrations/1694441090_updated_webauthnCredentials.js similarity index 100% rename from admin/pb_migrations/1694441090_updated_webauthnCredentials.js rename to pb_migrations/1694441090_updated_webauthnCredentials.js diff --git a/admin/pb_migrations/1695197120_created_organizations.js b/pb_migrations/1695197120_created_organizations.js similarity index 100% rename from admin/pb_migrations/1695197120_created_organizations.js rename to pb_migrations/1695197120_created_organizations.js diff --git a/admin/pb_migrations/1695199123_updated_organizations.js b/pb_migrations/1695199123_updated_organizations.js similarity index 100% rename from admin/pb_migrations/1695199123_updated_organizations.js rename to pb_migrations/1695199123_updated_organizations.js diff --git a/admin/pb_migrations/1695199164_updated_organizations.js b/pb_migrations/1695199164_updated_organizations.js similarity index 100% rename from admin/pb_migrations/1695199164_updated_organizations.js rename to pb_migrations/1695199164_updated_organizations.js diff --git a/admin/pb_migrations/1695371104_created_roles.js b/pb_migrations/1695371104_created_roles.js similarity index 100% rename from admin/pb_migrations/1695371104_created_roles.js rename to pb_migrations/1695371104_created_roles.js diff --git a/admin/pb_migrations/1695371373_created_organizationAuthorizations.js b/pb_migrations/1695371373_created_organizationAuthorizations.js similarity index 100% rename from admin/pb_migrations/1695371373_created_organizationAuthorizations.js rename to pb_migrations/1695371373_created_organizationAuthorizations.js diff --git a/admin/pb_migrations/1695372330_updated_organizationAuthorizations.js b/pb_migrations/1695372330_updated_organizationAuthorizations.js similarity index 100% rename from admin/pb_migrations/1695372330_updated_organizationAuthorizations.js rename to pb_migrations/1695372330_updated_organizationAuthorizations.js diff --git a/admin/pb_migrations/1695372719_updated_roles.js b/pb_migrations/1695372719_updated_roles.js similarity index 100% rename from admin/pb_migrations/1695372719_updated_roles.js rename to pb_migrations/1695372719_updated_roles.js diff --git a/admin/pb_migrations/1695373788_updated_users.js b/pb_migrations/1695373788_updated_users.js similarity index 100% rename from admin/pb_migrations/1695373788_updated_users.js rename to pb_migrations/1695373788_updated_users.js diff --git a/admin/pb_migrations/1695379174_updated_organizationAuthorizations.js b/pb_migrations/1695379174_updated_organizationAuthorizations.js similarity index 100% rename from admin/pb_migrations/1695379174_updated_organizationAuthorizations.js rename to pb_migrations/1695379174_updated_organizationAuthorizations.js diff --git a/admin/pb_migrations/1695379242_updated_organizationAuthorizations.js b/pb_migrations/1695379242_updated_organizationAuthorizations.js similarity index 100% rename from admin/pb_migrations/1695379242_updated_organizationAuthorizations.js rename to pb_migrations/1695379242_updated_organizationAuthorizations.js diff --git a/admin/pb_migrations/1695380238_updated_roles.js b/pb_migrations/1695380238_updated_roles.js similarity index 100% rename from admin/pb_migrations/1695380238_updated_roles.js rename to pb_migrations/1695380238_updated_roles.js diff --git a/admin/pb_migrations/1695653929_updated_organizations.js b/pb_migrations/1695653929_updated_organizations.js similarity index 100% rename from admin/pb_migrations/1695653929_updated_organizations.js rename to pb_migrations/1695653929_updated_organizations.js diff --git a/admin/pb_migrations/1696431796_updated_organizations.js b/pb_migrations/1696431796_updated_organizations.js similarity index 100% rename from admin/pb_migrations/1696431796_updated_organizations.js rename to pb_migrations/1696431796_updated_organizations.js diff --git a/admin/pb_migrations/1696502157_updated_organizationAuthorizations.js b/pb_migrations/1696502157_updated_organizationAuthorizations.js similarity index 100% rename from admin/pb_migrations/1696502157_updated_organizationAuthorizations.js rename to pb_migrations/1696502157_updated_organizationAuthorizations.js diff --git a/admin/pb_migrations/1696575925_created_protectedPaths.js b/pb_migrations/1696575925_created_protectedPaths.js similarity index 100% rename from admin/pb_migrations/1696575925_created_protectedPaths.js rename to pb_migrations/1696575925_created_protectedPaths.js diff --git a/admin/pb_migrations/1696585858_updated_organizationRoles.js b/pb_migrations/1696585858_updated_organizationRoles.js similarity index 100% rename from admin/pb_migrations/1696585858_updated_organizationRoles.js rename to pb_migrations/1696585858_updated_organizationRoles.js diff --git a/admin/pb_migrations/1696585879_updated_protectedPaths.js b/pb_migrations/1696585879_updated_protectedPaths.js similarity index 100% rename from admin/pb_migrations/1696585879_updated_protectedPaths.js rename to pb_migrations/1696585879_updated_protectedPaths.js diff --git a/admin/pb_migrations/1696598864_updated_organizationAuthorizations.js b/pb_migrations/1696598864_updated_organizationAuthorizations.js similarity index 100% rename from admin/pb_migrations/1696598864_updated_organizationAuthorizations.js rename to pb_migrations/1696598864_updated_organizationAuthorizations.js diff --git a/admin/pb_migrations/1696598918_updated_orgRoles.js b/pb_migrations/1696598918_updated_orgRoles.js similarity index 100% rename from admin/pb_migrations/1696598918_updated_orgRoles.js rename to pb_migrations/1696598918_updated_orgRoles.js diff --git a/admin/pb_migrations/1696598950_updated_organizations.js b/pb_migrations/1696598950_updated_organizations.js similarity index 100% rename from admin/pb_migrations/1696598950_updated_organizations.js rename to pb_migrations/1696598950_updated_organizations.js diff --git a/admin/pb_migrations/1696599006_updated_orgAuthorizations.js b/pb_migrations/1696599006_updated_orgAuthorizations.js similarity index 100% rename from admin/pb_migrations/1696599006_updated_orgAuthorizations.js rename to pb_migrations/1696599006_updated_orgAuthorizations.js diff --git a/admin/pb_migrations/1696603275_updated_orgProtectedPaths.js b/pb_migrations/1696603275_updated_orgProtectedPaths.js similarity index 100% rename from admin/pb_migrations/1696603275_updated_orgProtectedPaths.js rename to pb_migrations/1696603275_updated_orgProtectedPaths.js diff --git a/admin/pb_migrations/1696622801_updated_orgProtectedPaths.js b/pb_migrations/1696622801_updated_orgProtectedPaths.js similarity index 100% rename from admin/pb_migrations/1696622801_updated_orgProtectedPaths.js rename to pb_migrations/1696622801_updated_orgProtectedPaths.js diff --git a/admin/pb_migrations/1696849689_updated_orgRoles.js b/pb_migrations/1696849689_updated_orgRoles.js similarity index 100% rename from admin/pb_migrations/1696849689_updated_orgRoles.js rename to pb_migrations/1696849689_updated_orgRoles.js diff --git a/admin/pb_migrations/1696870220_updated_organizations.js b/pb_migrations/1696870220_updated_organizations.js similarity index 100% rename from admin/pb_migrations/1696870220_updated_organizations.js rename to pb_migrations/1696870220_updated_organizations.js diff --git a/admin/pb_migrations/1696870367_updated_orgAuthorizations.js b/pb_migrations/1696870367_updated_orgAuthorizations.js similarity index 100% rename from admin/pb_migrations/1696870367_updated_orgAuthorizations.js rename to pb_migrations/1696870367_updated_orgAuthorizations.js diff --git a/admin/pb_migrations/1698229181_created_orgJoinRequest.js b/pb_migrations/1698229181_created_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229181_created_orgJoinRequest.js rename to pb_migrations/1698229181_created_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229207_updated_orgJoinRequest.js b/pb_migrations/1698229207_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229207_updated_orgJoinRequest.js rename to pb_migrations/1698229207_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229226_updated_orgJoinRequest.js b/pb_migrations/1698229226_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229226_updated_orgJoinRequest.js rename to pb_migrations/1698229226_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229276_updated_orgJoinRequest.js b/pb_migrations/1698229276_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229276_updated_orgJoinRequest.js rename to pb_migrations/1698229276_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229293_updated_orgJoinRequest.js b/pb_migrations/1698229293_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229293_updated_orgJoinRequest.js rename to pb_migrations/1698229293_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229301_updated_orgJoinRequest.js b/pb_migrations/1698229301_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229301_updated_orgJoinRequest.js rename to pb_migrations/1698229301_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229324_updated_orgJoinRequest.js b/pb_migrations/1698229324_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229324_updated_orgJoinRequest.js rename to pb_migrations/1698229324_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229341_updated_orgJoinRequest.js b/pb_migrations/1698229341_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229341_updated_orgJoinRequest.js rename to pb_migrations/1698229341_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698229458_updated_orgJoinRequest.js b/pb_migrations/1698229458_updated_orgJoinRequest.js similarity index 100% rename from admin/pb_migrations/1698229458_updated_orgJoinRequest.js rename to pb_migrations/1698229458_updated_orgJoinRequest.js diff --git a/admin/pb_migrations/1698231235_updated_orgJoinRequests.js b/pb_migrations/1698231235_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1698231235_updated_orgJoinRequests.js rename to pb_migrations/1698231235_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1698242178_updated_orgJoinRequests.js b/pb_migrations/1698242178_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1698242178_updated_orgJoinRequests.js rename to pb_migrations/1698242178_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1698242304_updated_orgJoinRequests.js b/pb_migrations/1698242304_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1698242304_updated_orgJoinRequests.js rename to pb_migrations/1698242304_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1698244942_updated_orgJoinRequests.js b/pb_migrations/1698244942_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1698244942_updated_orgJoinRequests.js rename to pb_migrations/1698244942_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1698393887_updated_orgJoinRequests.js b/pb_migrations/1698393887_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1698393887_updated_orgJoinRequests.js rename to pb_migrations/1698393887_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1698394333_updated_orgJoinRequests.js b/pb_migrations/1698394333_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1698394333_updated_orgJoinRequests.js rename to pb_migrations/1698394333_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1700000000_seed_rooles.js b/pb_migrations/1700000000_seed_rooles.js similarity index 100% rename from admin/pb_migrations/1700000000_seed_rooles.js rename to pb_migrations/1700000000_seed_rooles.js diff --git a/admin/pb_migrations/1708687922_updated_users.js b/pb_migrations/1708687922_updated_users.js similarity index 100% rename from admin/pb_migrations/1708687922_updated_users.js rename to pb_migrations/1708687922_updated_users.js diff --git a/admin/pb_migrations/1709116531_updated_users.js b/pb_migrations/1709116531_updated_users.js similarity index 100% rename from admin/pb_migrations/1709116531_updated_users.js rename to pb_migrations/1709116531_updated_users.js diff --git a/admin/pb_migrations/1714492101_default_mail_settings.js b/pb_migrations/1714492101_default_mail_settings.js similarity index 100% rename from admin/pb_migrations/1714492101_default_mail_settings.js rename to pb_migrations/1714492101_default_mail_settings.js diff --git a/admin/pb_migrations/1715249207_created_users_public_keys.js b/pb_migrations/1715249207_created_users_public_keys.js similarity index 100% rename from admin/pb_migrations/1715249207_created_users_public_keys.js rename to pb_migrations/1715249207_created_users_public_keys.js diff --git a/admin/pb_migrations/1715331681_move_users_public_keys.js b/pb_migrations/1715331681_move_users_public_keys.js similarity index 100% rename from admin/pb_migrations/1715331681_move_users_public_keys.js rename to pb_migrations/1715331681_move_users_public_keys.js diff --git a/admin/pb_migrations/1715333405_updated_users.js b/pb_migrations/1715333405_updated_users.js similarity index 100% rename from admin/pb_migrations/1715333405_updated_users.js rename to pb_migrations/1715333405_updated_users.js diff --git a/admin/pb_migrations/1721422489_created_z_test_collection.js b/pb_migrations/1721422489_created_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1721422489_created_z_test_collection.js rename to pb_migrations/1721422489_created_z_test_collection.js diff --git a/admin/pb_migrations/1722850166_updated_orgAuthorizations.js b/pb_migrations/1722850166_updated_orgAuthorizations.js similarity index 100% rename from admin/pb_migrations/1722850166_updated_orgAuthorizations.js rename to pb_migrations/1722850166_updated_orgAuthorizations.js diff --git a/admin/pb_migrations/1722850178_updated_orgJoinRequests.js b/pb_migrations/1722850178_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1722850178_updated_orgJoinRequests.js rename to pb_migrations/1722850178_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1725893867_updated_users.js b/pb_migrations/1725893867_updated_users.js similarity index 100% rename from admin/pb_migrations/1725893867_updated_users.js rename to pb_migrations/1725893867_updated_users.js diff --git a/admin/pb_migrations/1726038316_updated_orgRoles.js b/pb_migrations/1726038316_updated_orgRoles.js similarity index 100% rename from admin/pb_migrations/1726038316_updated_orgRoles.js rename to pb_migrations/1726038316_updated_orgRoles.js diff --git a/admin/pb_migrations/1726038450_seed_roles_with_level.js b/pb_migrations/1726038450_seed_roles_with_level.js similarity index 100% rename from admin/pb_migrations/1726038450_seed_roles_with_level.js rename to pb_migrations/1726038450_seed_roles_with_level.js diff --git a/admin/pb_migrations/1726475967_updated_orgAuthorizations.js b/pb_migrations/1726475967_updated_orgAuthorizations.js similarity index 100% rename from admin/pb_migrations/1726475967_updated_orgAuthorizations.js rename to pb_migrations/1726475967_updated_orgAuthorizations.js diff --git a/admin/pb_migrations/1727194827_deleted_orgProtectedPaths.js b/pb_migrations/1727194827_deleted_orgProtectedPaths.js similarity index 100% rename from admin/pb_migrations/1727194827_deleted_orgProtectedPaths.js rename to pb_migrations/1727194827_deleted_orgProtectedPaths.js diff --git a/admin/pb_migrations/1727420027_updated_orgJoinRequests.js b/pb_migrations/1727420027_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1727420027_updated_orgJoinRequests.js rename to pb_migrations/1727420027_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1727427248_updated_orgJoinRequests.js b/pb_migrations/1727427248_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1727427248_updated_orgJoinRequests.js rename to pb_migrations/1727427248_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1727434248_updated_orgJoinRequests.js b/pb_migrations/1727434248_updated_orgJoinRequests.js similarity index 100% rename from admin/pb_migrations/1727434248_updated_orgJoinRequests.js rename to pb_migrations/1727434248_updated_orgJoinRequests.js diff --git a/admin/pb_migrations/1727434645_updated_organizations.js b/pb_migrations/1727434645_updated_organizations.js similarity index 100% rename from admin/pb_migrations/1727434645_updated_organizations.js rename to pb_migrations/1727434645_updated_organizations.js diff --git a/admin/pb_migrations/1727719328_created_org_invite.js b/pb_migrations/1727719328_created_org_invite.js similarity index 100% rename from admin/pb_migrations/1727719328_created_org_invite.js rename to pb_migrations/1727719328_created_org_invite.js diff --git a/admin/pb_migrations/1727720630_updated_org_invite.js b/pb_migrations/1727720630_updated_org_invite.js similarity index 100% rename from admin/pb_migrations/1727720630_updated_org_invite.js rename to pb_migrations/1727720630_updated_org_invite.js diff --git a/admin/pb_migrations/1727792062_updated_org_invite.js b/pb_migrations/1727792062_updated_org_invite.js similarity index 100% rename from admin/pb_migrations/1727792062_updated_org_invite.js rename to pb_migrations/1727792062_updated_org_invite.js diff --git a/admin/pb_migrations/1727793426_updated_org_invites.js b/pb_migrations/1727793426_updated_org_invites.js similarity index 100% rename from admin/pb_migrations/1727793426_updated_org_invites.js rename to pb_migrations/1727793426_updated_org_invites.js diff --git a/admin/pb_migrations/1727796849_updated_org_invites.js b/pb_migrations/1727796849_updated_org_invites.js similarity index 100% rename from admin/pb_migrations/1727796849_updated_org_invites.js rename to pb_migrations/1727796849_updated_org_invites.js diff --git a/admin/pb_migrations/1727796874_updated_org_invites.js b/pb_migrations/1727796874_updated_org_invites.js similarity index 100% rename from admin/pb_migrations/1727796874_updated_org_invites.js rename to pb_migrations/1727796874_updated_org_invites.js diff --git a/admin/pb_migrations/1727798303_updated_org_invites.js b/pb_migrations/1727798303_updated_org_invites.js similarity index 100% rename from admin/pb_migrations/1727798303_updated_org_invites.js rename to pb_migrations/1727798303_updated_org_invites.js diff --git a/admin/pb_migrations/1727798588_updated_org_invites.js b/pb_migrations/1727798588_updated_org_invites.js similarity index 100% rename from admin/pb_migrations/1727798588_updated_org_invites.js rename to pb_migrations/1727798588_updated_org_invites.js diff --git a/admin/pb_migrations/1727800869_updated_org_invites.js b/pb_migrations/1727800869_updated_org_invites.js similarity index 100% rename from admin/pb_migrations/1727800869_updated_org_invites.js rename to pb_migrations/1727800869_updated_org_invites.js diff --git a/admin/pb_migrations/1727854886_updated_org_invites.js b/pb_migrations/1727854886_updated_org_invites.js similarity index 100% rename from admin/pb_migrations/1727854886_updated_org_invites.js rename to pb_migrations/1727854886_updated_org_invites.js diff --git a/admin/pb_migrations/1728470648_updated_z_test_collection.js b/pb_migrations/1728470648_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1728470648_updated_z_test_collection.js rename to pb_migrations/1728470648_updated_z_test_collection.js diff --git a/admin/pb_migrations/1728481427_updated_z_test_collection.js b/pb_migrations/1728481427_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1728481427_updated_z_test_collection.js rename to pb_migrations/1728481427_updated_z_test_collection.js diff --git a/admin/pb_migrations/1728481532_updated_z_test_collection.js b/pb_migrations/1728481532_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1728481532_updated_z_test_collection.js rename to pb_migrations/1728481532_updated_z_test_collection.js diff --git a/admin/pb_migrations/1728563836_updated_z_test_collection.js b/pb_migrations/1728563836_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1728563836_updated_z_test_collection.js rename to pb_migrations/1728563836_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729074142_updated_z_test_collection.js b/pb_migrations/1729074142_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729074142_updated_z_test_collection.js rename to pb_migrations/1729074142_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729074280_updated_z_test_collection.js b/pb_migrations/1729074280_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729074280_updated_z_test_collection.js rename to pb_migrations/1729074280_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729096464_updated_z_test_collection.js b/pb_migrations/1729096464_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729096464_updated_z_test_collection.js rename to pb_migrations/1729096464_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729755967_updated_z_test_collection.js b/pb_migrations/1729755967_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729755967_updated_z_test_collection.js rename to pb_migrations/1729755967_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729757085_updated_z_test_collection.js b/pb_migrations/1729757085_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729757085_updated_z_test_collection.js rename to pb_migrations/1729757085_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729843574_updated_z_test_collection.js b/pb_migrations/1729843574_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729843574_updated_z_test_collection.js rename to pb_migrations/1729843574_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729930153_updated_z_test_collection.js b/pb_migrations/1729930153_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729930153_updated_z_test_collection.js rename to pb_migrations/1729930153_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729930209_updated_z_test_collection.js b/pb_migrations/1729930209_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729930209_updated_z_test_collection.js rename to pb_migrations/1729930209_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729930438_updated_z_test_collection.js b/pb_migrations/1729930438_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729930438_updated_z_test_collection.js rename to pb_migrations/1729930438_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729930444_updated_z_test_collection.js b/pb_migrations/1729930444_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729930444_updated_z_test_collection.js rename to pb_migrations/1729930444_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729930951_updated_z_test_collection.js b/pb_migrations/1729930951_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1729930951_updated_z_test_collection.js rename to pb_migrations/1729930951_updated_z_test_collection.js diff --git a/admin/pb_migrations/1729933259_deleted_authorizationsExamples.js b/pb_migrations/1729933259_deleted_authorizationsExamples.js similarity index 100% rename from admin/pb_migrations/1729933259_deleted_authorizationsExamples.js rename to pb_migrations/1729933259_deleted_authorizationsExamples.js diff --git a/admin/pb_migrations/1730125916_updated_z_test_collection.js b/pb_migrations/1730125916_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1730125916_updated_z_test_collection.js rename to pb_migrations/1730125916_updated_z_test_collection.js diff --git a/admin/pb_migrations/1730129064_deleted_crudExample.js b/pb_migrations/1730129064_deleted_crudExample.js similarity index 100% rename from admin/pb_migrations/1730129064_deleted_crudExample.js rename to pb_migrations/1730129064_deleted_crudExample.js diff --git a/admin/pb_migrations/1730129141_updated_z_test_collection.js b/pb_migrations/1730129141_updated_z_test_collection.js similarity index 100% rename from admin/pb_migrations/1730129141_updated_z_test_collection.js rename to pb_migrations/1730129141_updated_z_test_collection.js diff --git a/admin/pb_migrations/1730134615_updated_orgAuthorizations.js b/pb_migrations/1730134615_updated_orgAuthorizations.js similarity index 100% rename from admin/pb_migrations/1730134615_updated_orgAuthorizations.js rename to pb_migrations/1730134615_updated_orgAuthorizations.js diff --git a/admin/pb_migrations/1734523066_feature_oauth.js b/pb_migrations/1734523066_feature_oauth.js similarity index 100% rename from admin/pb_migrations/1734523066_feature_oauth.js rename to pb_migrations/1734523066_feature_oauth.js diff --git a/admin/pb_migrations/1734947817_created_tests.js b/pb_migrations/1734947817_created_tests.js similarity index 100% rename from admin/pb_migrations/1734947817_created_tests.js rename to pb_migrations/1734947817_created_tests.js diff --git a/admin/pb_migrations/1734951182_created_services.js b/pb_migrations/1734951182_created_services.js similarity index 100% rename from admin/pb_migrations/1734951182_created_services.js rename to pb_migrations/1734951182_created_services.js diff --git a/admin/scripts/create-test-data.sh b/scripts/create-test-data.sh similarity index 100% rename from admin/scripts/create-test-data.sh rename to scripts/create-test-data.sh diff --git a/webapp/package.json b/webapp/package.json index 9294de8..d078704 100644 --- a/webapp/package.json +++ b/webapp/package.json @@ -1,101 +1,101 @@ { - "name": "DIDimo - webapp", - "author": { - "name": "Forkbomb", - "email": "info@forkbomb.com" - }, - "description": "Your trustworthy compliance checker for decentralized identity solutions", - "version": "0.0.1", - "type": "module", - "engines": { - "node": ">=17", - "pnpm": ">=8" - }, - "scripts": { - "predev": "pnpm generate:definitions", - "dev": "vite dev", - "prebuild": "pnpm generate:definitions", - "build": "vite build", - "preview": "vite preview", - "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json", - "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch", - "format": "prettier --write .", - "lint": "prettier --check . && eslint .", - "test:unit": "vitest", - "test": "pnpm test:unit -- --run && pnpm test:e2e", - "test:e2e": "playwright test", - "test:e2e:ui": "playwright test --ui", - "serve": "pnpm build && pnpm preview --host", - "vite-run": "node ./vite-run.js", - "generate:types": "pnpm dlx pocketbase-typegen@1.2.1 --env --out src/modules/pocketbase/types/index.generated.ts && pnpm generate:types-extra", - "generate:types-extra": "pnpm vite-run src/modules/pocketbase/types/generate.types-extra.ts", - "generate:features": "pnpm vite-run src/modules/features/generate.features-list.ts", - "generate:roles": "pnpm vite-run ./src/modules/organizations/generate.roles-list.ts", - "generate:collections-models": "pnpm vite-run ./src/modules/pocketbase/collections-models/generate.collections-models.ts", - "generate:definitions": "pnpm generate:collections-models && pnpm generate:types && pnpm generate:features && pnpm generate:roles", - "i18n:remove-unused-strings": "pnpm vite-run ./src/modules/i18n/remove-unused-strings.ts", - "i18n:lint": "pnpm inlang lint --project ./project.inlang", - "i18n:lint:en": "pnpm inlang lint --project ./project.inlang --languageTags en", - "emails": "rm -rf static/emails/* && mkdir -p static/emails && find ./ -name _components -prune -o -name '*.mjml' -exec sh -c 'mjml \"$1\" -o static/emails/$(basename \"${1%.mjml}.html\")' sh {} \\;", - "postemails": "node ./emails/_generateEmailList.mjs" - }, - "devDependencies": { - "@inlang/cli": "^2.18.1", - "@internationalized/date": "^3.5.6", - "@playwright/test": "^1.45.3", - "@sveltejs/adapter-auto": "^3.0.0", - "@sveltejs/kit": "^2.12.2", - "@sveltejs/vite-plugin-svelte": "^4.0.0", - "@tailwindcss/aspect-ratio": "^0.4.2", - "@tailwindcss/container-queries": "^0.1.1", - "@tailwindcss/forms": "^0.5.9", - "@tailwindcss/typography": "^0.5.15", - "@types/eslint": "^9.6.0", - "@types/lodash": "^4.17.13", - "autoprefixer": "^10.4.20", - "bits-ui": "1.0.0-next.74", - "clsx": "^2.1.1", - "dotenv": "^16.4.5", - "eslint": "^9.7.0", - "eslint-config-prettier": "^9.1.0", - "eslint-plugin-svelte": "^2.36.0", - "formsnap": "2.0.0-next.1", - "globals": "^15.0.0", - "json-to-ts": "^2.1.0", - "lucide-svelte": "^0.454.0", - "mode-watcher": "^0.4.1", - "paneforge": "1.0.0-next.2", - "prettier": "^3.3.2", - "prettier-plugin-svelte": "^3.2.6", - "prettier-plugin-tailwindcss": "^0.6.5", - "svelte": "^5.14.4", - "svelte-check": "^4.0.0", - "svelte-sonner": "^0.3.28", - "sveltekit-superforms": "^2.20.0", - "tailwind-merge": "^2.5.4", - "tailwind-variants": "^0.2.1", - "tailwindcss": "^3.4.9", - "tailwindcss-animate": "^1.0.7", - "typescript": "^5.0.0", - "typescript-eslint": "^8.0.0", - "vite": "^5.0.3", - "vite-node": "^2.1.4", - "vitest": "^2.0.4", - "zod": "^3.23.8" - }, - "dependencies": { - "@inlang/paraglide-sveltekit": "^0.15.0", - "@melt-ui/svelte": "^0.86.0", - "@types/node": "^22.10.2", - "date-fns": "^4.1.0", - "effect": "^3.10.12", - "lodash": "^4.17.21", - "mjml": "^4.15.3", - "nanoid": "^5.0.8", - "pocketbase": "^0.21.5", - "runed": "^0.15.3", - "svelte-loading-spinners": "^0.3.6", - "type-fest": "^4.26.1", - "zenroom": "^4.45.3" - } + "name": "DIDimo - webapp", + "author": { + "name": "Forkbomb", + "email": "info@forkbomb.com" + }, + "description": "Your trustworthy compliance checker for decentralized identity solutions", + "version": "0.0.1", + "type": "module", + "engines": { + "node": ">=17", + "pnpm": ">=8" + }, + "scripts": { + "predev": "pnpm generate:definitions", + "dev": "vite dev", + "prebuild": "pnpm generate:definitions", + "build": "vite build", + "preview": "vite preview", + "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json", + "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch", + "format": "prettier --write .", + "lint": "prettier --check . && eslint .", + "test:unit": "vitest", + "test": "pnpm test:unit -- --run && pnpm test:e2e", + "test:e2e": "playwright test", + "test:e2e:ui": "playwright test --ui", + "serve": "pnpm build && pnpm preview --host", + "vite-run": "node ./vite-run.js", + "generate:types": "pnpm dlx pocketbase-typegen@1.2.1 --env --out src/modules/pocketbase/types/index.generated.ts && pnpm generate:types-extra", + "generate:types-extra": "pnpm vite-run src/modules/pocketbase/types/generate.types-extra.ts", + "generate:features": "pnpm vite-run src/modules/features/generate.features-list.ts", + "generate:roles": "pnpm vite-run ./src/modules/organizations/generate.roles-list.ts", + "generate:collections-models": "pnpm vite-run ./src/modules/pocketbase/collections-models/generate.collections-models.ts", + "generate:definitions": "pnpm generate:collections-models && pnpm generate:types && pnpm generate:features && pnpm generate:roles", + "i18n:remove-unused-strings": "pnpm vite-run ./src/modules/i18n/remove-unused-strings.ts", + "i18n:lint": "pnpm inlang lint --project ./project.inlang", + "i18n:lint:en": "pnpm inlang lint --project ./project.inlang --languageTags en", + "emails": "rm -rf static/emails/* && mkdir -p static/emails && find ./ -name _components -prune -o -name '*.mjml' -exec sh -c 'mjml \"$1\" -o static/emails/$(basename \"${1%.mjml}.html\")' sh {} \\;", + "postemails": "node ./emails/_generateEmailList.mjs" + }, + "devDependencies": { + "@inlang/cli": "^2.18.1", + "@internationalized/date": "^3.5.6", + "@playwright/test": "^1.45.3", + "@sveltejs/adapter-auto": "^3.0.0", + "@sveltejs/kit": "^2.12.2", + "@sveltejs/vite-plugin-svelte": "^4.0.0", + "@tailwindcss/aspect-ratio": "^0.4.2", + "@tailwindcss/container-queries": "^0.1.1", + "@tailwindcss/forms": "^0.5.9", + "@tailwindcss/typography": "^0.5.15", + "@types/eslint": "^9.6.0", + "@types/lodash": "^4.17.13", + "autoprefixer": "^10.4.20", + "bits-ui": "1.0.0-next.74", + "clsx": "^2.1.1", + "dotenv": "^16.4.5", + "eslint": "^9.7.0", + "eslint-config-prettier": "^9.1.0", + "eslint-plugin-svelte": "^2.36.0", + "formsnap": "2.0.0-next.1", + "globals": "^15.0.0", + "json-to-ts": "^2.1.0", + "lucide-svelte": "^0.454.0", + "mode-watcher": "^0.4.1", + "paneforge": "1.0.0-next.2", + "prettier": "^3.3.2", + "prettier-plugin-svelte": "^3.2.6", + "prettier-plugin-tailwindcss": "^0.6.5", + "svelte": "^5.14.4", + "svelte-check": "^4.0.0", + "svelte-sonner": "^0.3.28", + "sveltekit-superforms": "^2.20.0", + "tailwind-merge": "^2.5.4", + "tailwind-variants": "^0.2.1", + "tailwindcss": "^3.4.9", + "tailwindcss-animate": "^1.0.7", + "typescript": "^5.0.0", + "typescript-eslint": "^8.0.0", + "vite": "^5.0.3", + "vite-node": "^2.1.4", + "vitest": "^2.0.4", + "zod": "^3.23.8" + }, + "dependencies": { + "@inlang/paraglide-sveltekit": "^0.15.0", + "@melt-ui/svelte": "^0.86.0", + "@types/node": "^22.10.2", + "date-fns": "^4.1.0", + "effect": "^3.10.12", + "lodash": "^4.17.21", + "mjml": "^4.15.3", + "nanoid": "^5.0.8", + "pocketbase": "^0.21.5", + "runed": "^0.15.3", + "svelte-loading-spinners": "^0.3.6", + "type-fest": "^4.26.1", + "zenroom": "^4.45.3" + } } diff --git a/webapp/src/modules/organizations/verify-authorizations.ts b/webapp/src/modules/organizations/verify-authorizations.ts index 167ed1b..89b603a 100644 --- a/webapp/src/modules/organizations/verify-authorizations.ts +++ b/webapp/src/modules/organizations/verify-authorizations.ts @@ -1,7 +1,7 @@ import { pb } from '@/pocketbase'; import type { OrgRole } from '.'; -/* Reference: admin/pb_hooks/organizations.routes.pb.js */ +/* Reference: pb_hooks/organizations.routes.pb.js */ export async function verifyUserMembership( organizationId: string, diff --git a/admin/webauthn/webauthn.go b/webauthn/webauthn.go similarity index 100% rename from admin/webauthn/webauthn.go rename to webauthn/webauthn.go diff --git a/admin/zencode/zencode.go b/zencode/zencode.go similarity index 100% rename from admin/zencode/zencode.go rename to zencode/zencode.go diff --git a/admin/zencode/zenflows-crypto b/zencode/zenflows-crypto similarity index 100% rename from admin/zencode/zenflows-crypto rename to zencode/zenflows-crypto