diff --git a/LICENSE_AMBIENT b/LICENSE_AMBIENT deleted file mode 100644 index 9487f31..0000000 --- a/LICENSE_AMBIENT +++ /dev/null @@ -1,7 +0,0 @@ -Copyright (C) 2025 Voleum - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSE_PLATFORM b/LICENSE_PLATFORM deleted file mode 100644 index be3f7b2..0000000 --- a/LICENSE_PLATFORM +++ /dev/null @@ -1,661 +0,0 @@ - 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/README.org b/README.org index ec724be..207266d 100644 --- a/README.org +++ b/README.org @@ -1,12 +1,58 @@ +:PROPERTIES: +:ID: 55a85682-80d7-41fe-ab55-d3afe9abbc38 +:END: +#+OPTIONS: toc:nil +#+BEGIN_EXPORT html + +#+END_EXPORT #+title: Grimu-R -*Grimu-R* is an open ecosystem and a framework for mixed visual-textual dataflow scripting. +Grimu-R is an *open ecosystem* and a framework for mixed visual-textual *dataflow* scripting. It consists primarily of the following components: -- Interactive web-based *visual-textual* editor -- *Polyglot scripting* runtime environment - Execution model allowing computations to be expressed as *reactive graphs* +- *Polyglot scripting* runtime environment +- Live web-based *visual-textual* editor #+TOC: headlines 2 * Table of Contents :TOC_2_gh:noexport: +- [[#inspiration][Inspiration]] - [[#goals][Goals]] - [[#immediate-feedback-and-composability][Immediate feedback and composability]] - [[#embeddable-build-targets][Embeddable build targets]] @@ -20,8 +66,8 @@ It consists primarily of the following components: - [[#positioning][Positioning]] - [[#nomenclature][Nomenclature]] - [[#weave][Weave]] - - [[#braid][Braid]] - - [[#sigil][Sigil]] + - [[#ornament][Ornament]] + - [[#spell][Spell]] - [[#scroll][Scroll]] - [[#inscription][Inscription]] - [[#how-it-works][How it works]] @@ -29,15 +75,19 @@ It consists primarily of the following components: - [[#workflow][Workflow]] - [[#cross-language-connections][Cross-language connections]] - [[#execution-environment][Execution environment]] +- [[#features][Features]] - [[#faq][FAQ]] - [[#is-this-a-yet-another-web-framework][Is this a yet another web framework?]] - - [[#how-does-malleability-work-in-client-server-applications][How does malleability work in client-server applications?]] + - [[#a-user-can-execute-arbitrary-code-on-my-backend-really][A user can execute arbitrary code on my backend? Really?]] - [[#can-i-opt-out-of-nix][Can I opt out of Nix?]] - [[#how-do-i-test-my-weave][How do I test my weave?]] - - [[#can-i-integrate-ai-models][Can I integrate AI models?]] -- [[#licensing][Licensing]] - - [[#compliance-guide][Compliance guide]] + - [[#can-i-intergate-ai-models][Can I intergate AI models?]] +* Inspiration +- [[https://github.com/enso-org/enso][Enso]] +- [[https://unit.software][Unit]] +- [[https://jupyter.org/][Jupyter Notebooks]] +- [[https://observablehq.com/][Observable]] * Goals ** Immediate feedback and composability @@ -49,16 +99,12 @@ experiment and reuse previous work. An interactive visual editor allows one to prototype, debug and run one-off jobs comfortably. But the work can always be distilled into an executable artifact: -a CLI tool, an RPC server, or a web application, to be distributed as such or integrated into larger flows. +a CLI tool, an RPC server, or a web application, to be distributed as such or integrated into larger workflows. ** Hassle-free reproducible builds Powered by Nix, Grimu-R projects require minimal effort to build, run, or depend on. -For interactive use with scripts, the default mode is runtime dependency loading. - -For builds, it is recommended to have dependencies defined statically and provisioned by Nix. - ** Reactivity taken seriously Push or pull? Throttle, debounce, batch? @@ -81,21 +127,23 @@ Real code blocks in familiar languages are prioritized from day one, leveraging Get started without implementing your own components. -Low code to high code. +No code to low code to high code. * Non-goals -Some things Grimu-R itself will not take care of, delegating them to the surrounding environment or just omitting: +Some things Grimu-R itself will not take care of, delegating them to the surrounding environment: - Resumable/durable execution -- Real-time collaborative editing +- Distributed computing (outside of client-server) +- Collaborative editing +- Untrusted code sandboxing - Authentication and access control - Telemetry * Use cases -- Rapid prototyping of *data processing* pipelines -- *Self-hosted* workflow automation -- *Dashboards* with custom logic -- *Internal tooling* and automation scripts -- Hacker-friendly, highly *customizable* applications +- Rapid prototyping of data processing pipelines +- Self-hosted workflow automation +- Dashboards with custom logic +- Internal tooling and automation scripts +- Hacker-friendly, highly customizable applications * Positioning Grimu-R aims to take the best without the worst from: @@ -113,53 +161,51 @@ Below is a brief explanation for the key terms: A Grimu-R project's weave is what changes when someone is working on it ("weaving"). -It's a persistent, Git-friendly representation of the dataflow graph and its graphic layout. +It's a persistent representation of the dataflow graph and its graphic layout. -** Braid +** Ornament -Weaves are composed of braids, which serve the dual purpose of reusable modules and entry points. +Weaves are composed of ornaments, which serve the dual purpose of reusable modules and entry points. -An braid could correspond to an RPC method or a CLI subcommand in a build. +An ornament would correspond to an RPC method or a CLI subcommand. -Braids can be nested within other braids, appearing as single nodes that encapsulate their internal graphs. +Ornaments can be nested within other ornaments, appearing as single nodes that encapsulate their internal graphs. -** Sigil +** Spell -Sigils are the basic building blocks for braids. +Spells are the basic building blocks for ornaments. -A sigil is just a normal computer program that acts as: +A spell is just a normal computer program that acts as: - data source (e. g. a static CSV sheet) - data sink (e. g. a POST endpoint) - data transformer (e. g. grep) -Each sigil is based on a scroll and can contain a dynamic script ("inscription") stored in the weave. +Each spell is based on a scroll and can contain a dynamic script ("inscription") stored in the weave. ** Scroll -Scrolls define a default configuration for sigils, as well as the runtime environment to run a sigil in. +Scrolls define a default configuration for spells, as well as the runtime environment to run a spell in. -They are developed outside of Grimu-R using standard development tooling and integrated with Nix. +They are developed outside of Grimu-R using standard development tooling. ** Inscription -Sigils based on interpreter scrolls (like Bash, Node.js) can have their inscriptions edited +Spells based on interpreter scrolls (like Bash, Node.js) can have their inscriptions edited directly in the visual editor, enabling live code changes without rebuilding the development environment. -There can be other kinds of inscriptions: templates, configurations, parameters, etc. - * How it works ** Development environment -Grimu-R projects being Nix flakes, the development tooling ("loom") is provisioned in a Nix shell. +Grimu-R projects being Nix flakes, the development tooling ("loom") is provisioned as a Nix shell. -It gives you the visual editor, the companion CLI tool and the execution context for sigils. +It gives you the visual editor, the companion CLI tool and the execution context for spells. ** Workflow - The visual editor is served by a development or application server. -- Changes and execution requests for natively executed sigils are sent over a bidirectional WebSocket connection. +- Changes and execution requests for server-side spells are sent over a bidirectional WebSocket connection. - User modifications are stored locally in the browser's storage, exportable as a file. -- Weaves are tracked by usual VCS tools. +- Weaves are tracked by usual VSC tools. ** Cross-language connections @@ -167,15 +213,21 @@ Think Unix pipes but with structured data formats like JSON lines instead of pla ** Execution environment -Purpose-specific scrolls used in a weave have their requirements defined in Nix terms. +Scrolls used in a weave have their requirements defined in Nix terms. -For example, if several scrolls need Deno, they can all refer to the same deno Nix package defined in the flake's nixpkgs overlay and declare their Deno dependencies normally in deno.json. - -A single copy of Deno runtime and a shared Deno cache would be bundled in a build. - -However, the general-purpose Deno scroll executing arbitrary TypeScript inscriptions -would have Deno fetch dependencies during runtime. +For example, if several scrolls need Node.js, they can all refer to the same nodejs Nix package defined in the flake. +All of that, and optionally the visual editor, is bundled into a target build ("edition"). +* Features +| | On the roadmap | Ideas | +|--------------------------+--------------------------------+--------------------| +| Editions (build targets) | Self-sufficient CLI executable | Mobile application | +| | CLI client + RPC server | React component | +| | Web application | | +| | | | +| Scripting languages | TypeScript | DuckDB SQL | +| | Bash | Python | +| | Haskell | R | * FAQ ** Is this a yet another web framework? @@ -186,87 +238,37 @@ One framework called [[https://cycle.js.org/][Cycle.js]] defines a web applicati Grimu-R can do a similar thing if you want it to. Or you could use any framework you like with the dataflow stuff being incidental. -** How does malleability work in client-server applications? +** A user can execute arbitrary code on my backend? Really? -Unlike standalone builds executing entirely on the end user's machine, -client-server builds split the weave between runtime components. +By default, any client-server Grimu-R build ("edition") would allow users to see +and edit client-side parts of the weave only. -Only the client-side part of the weave can be inspected and edited by -the end user. +This is but superficially different from users messing around in their +browser's console or employing a browser extension. + +On the other hand, if the server-side parts run in a trusted environment with authorized access, +you could give users a more generous degree of control. ** Can I opt out of Nix? To some extent, yes. While Grimu-R is built on top of Nix and wouldn't make a lot of sense otherwise, -you always have the option to access out-of-store files from your sigils, +you always have the option to access out-of-store files from your spells' inscriptions, at the cost of reproducibility. -So you could use e. g. runtime JS imports or call some executable on PATH from a shell script. - ** How do I test my weave? If you do it manually: right in the visual editor. -Add sigils with a constant output as test data sources and connect them to the sigils you want to test. +Add spells with a constant output as test data sources and stitch them to the spells you want to test. -If you need automation: call the braids programmatically. -If you already have test data stored in the weave, you can extract it by the sigil's id using loom CLI or library. +If you need automation: build an edition and call the ornaments programmatically. +If you already have test data stored in the weave, you can extract it by the spell's id using loom CLI or library. -** Can I integrate AI models? +** Can I intergate AI models? -There are three integration scenarios which would make sense: +If you want something like [[https://computer.tldraw.com/][tldraw computer]], Grimu-R would accomodate that and beyond, +potentially supporting fancier features like tool use and MCP servers. -1. AI sigils in the weave: +However, until someone contributes scrolls tailored for the purpose, Grimu-R would offer worse ergonomics. - Sigils calling inference APIs, equipped with MCP sigils and - template sigils for prompt composition - -2. AI weaving copilot: - - Loom providing AI tools to edit the weave - -3. MCP server builds: - - Braids exposed as tools for external AI systems - -#1 is easy to do even with no out-of-the-box support. - -#2 and #3 would require some work on development tooling. - -* Licensing -The Grimu-R platform components, including Loom development utilities and -the weave executor builders, are licensed under AGPL v3. - -Base scrolls and other non-platform code are licensed under MIT. - -** Repository Structure :noexport: -In this repository: -- Platform components are in the ~platform/~ directory -- Everything outside ~platform/~ falls under MIT licensing -- Full license texts are in ~LICENSE_PLATFORM~ and ~LICENSE_AMBIENT~ - -** Copyright and Contributions :noexport: -Copyright (C) 2025 Voleum - -By contributing to this repository, you assign your copyright to Voleum under -the condition that your contribution will always remain available under the -original license terms specified above. - -Alternative contribution arrangements may be available upon request. - -** Compliance guide -Your options for licensing your work are restricted in the following scenarios: - -1. You fork Loom or weave executor builders and distribute your fork. -2. You build a product extending the platform's or its fork's functionality - while incorporating their code. -3. Your weave or scrolls make use of third-party copyleft-licensed software. - This is independent of Grimu-R platform's licensing. - -Note that AGPL terms apply even for SaaS solutions. - -Loom being AGPL does not affect the licensing of weaves you develop using it. - -Weave executors being AGPL means that your application using them has -to provide AGPL license notice and link to their source code repository; -your application's code, however, needs not be provided. diff --git a/flake.lock b/flake.lock index 2a7de6f..5feb92a 100644 --- a/flake.lock +++ b/flake.lock @@ -1,44 +1,5 @@ { "nodes": { - "deno-with-packages": { - "inputs": { - "flake-utils": "flake-utils", - "nixpkgs": [ - "nixpkgs" - ] - }, - "locked": { - "lastModified": 1754403929, - "narHash": "sha256-2+VxvvvOQOmidNGEbJibuYyyFufEvnr37evnZxcf7ao=", - "owner": "voleum-org", - "repo": "deno-with-packages", - "rev": "47ad6f8ad05062db9a2b3dc421f8a0ea5484ce41", - "type": "github" - }, - "original": { - "owner": "voleum-org", - "repo": "deno-with-packages", - "type": "github" - } - }, - "flake-parts": { - "inputs": { - "nixpkgs-lib": "nixpkgs-lib" - }, - "locked": { - "lastModified": 1754487366, - "narHash": "sha256-pHYj8gUBapuUzKV/kN/tR3Zvqc7o6gdFB9XKXIp1SQ8=", - "owner": "hercules-ci", - "repo": "flake-parts", - "rev": "af66ad14b28a127c5c0f3bbb298218fc63528a18", - "type": "github" - }, - "original": { - "owner": "hercules-ci", - "repo": "flake-parts", - "type": "github" - } - }, "flake-utils": { "inputs": { "systems": "systems" @@ -73,25 +34,9 @@ "type": "github" } }, - "nixpkgs-lib": { - "locked": { - "lastModified": 1753579242, - "narHash": "sha256-zvaMGVn14/Zz8hnp4VWT9xVnhc8vuL3TStRqwk22biA=", - "owner": "nix-community", - "repo": "nixpkgs.lib", - "rev": "0f36c44e01a6129be94e3ade315a5883f0228a6e", - "type": "github" - }, - "original": { - "owner": "nix-community", - "repo": "nixpkgs.lib", - "type": "github" - } - }, "root": { "inputs": { - "deno-with-packages": "deno-with-packages", - "flake-parts": "flake-parts", + "flake-utils": "flake-utils", "nixpkgs": "nixpkgs" } }, diff --git a/flake.nix b/flake.nix index 734a8dc..d65e5cb 100644 --- a/flake.nix +++ b/flake.nix @@ -3,34 +3,24 @@ inputs = { nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; - flake-parts.url = "github:hercules-ci/flake-parts"; - deno-with-packages.url = "github:voleum-org/deno-with-packages"; - deno-with-packages.inputs.nixpkgs.follows = "nixpkgs"; + flake-utils.url = "github:numtide/flake-utils"; }; - outputs = inputs: inputs.flake-parts.lib.mkFlake { inherit inputs; } { - imports = [ - ]; - systems = [ "x86_64-linux" ]; - perSystem = { self', pkgs, config, system, ... }: let - lib = import ./nix // inputs.deno-with-packages.lib.${system}; - shelf = import ./shelf { - inherit pkgs system lib; - }; - in { - packages.website = - import ./nix/website.nix { inherit pkgs; root = ./.; }; - - devShells.default = pkgs.mkShell { - buildInputs = [ pkgs.deno pkgs.pandoc ]; - shellHook = '' - export DENO_DIR=$PWD/.deno_cache - ${shelf.setupScript}/bin/install-deno-cache - - echo "Available scrolls:" - echo ${pkgs.lib.escapeShellArg (builtins.toJSON shelf.scrolls)} | jq . - ''; - }; - }; - }; + outputs = { self, nixpkgs, flake-utils }: + flake-utils.lib.eachDefaultSystem (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + shelf = import ./shelf { + inherit pkgs system; + }; + in + { + packages.shelf = shelf; + devShells.default = pkgs.mkShell { + buildInputs = [ ]; + shellHook = '' + ${shelf.setupScript} + ''; + }; + }); } diff --git a/nix/default.nix b/nix/default.nix deleted file mode 100644 index ae0c2e7..0000000 --- a/nix/default.nix +++ /dev/null @@ -1,6 +0,0 @@ -let - lib = { - discoverScrolls = import ./discoverScrolls.nix { self = lib; }; - }; -in -lib diff --git a/nix/discoverScrolls.nix b/nix/discoverScrolls.nix deleted file mode 100644 index 04bcfec..0000000 --- a/nix/discoverScrolls.nix +++ /dev/null @@ -1,29 +0,0 @@ -{ self }: -{ scrollsDir }: -let - allSubDirs = builtins.attrNames ( - builtins.readDir scrollsDir - ); - - directoriesOnly = builtins.filter (name: - let - type = (builtins.readDir scrollsDir).${name}; - in type == "directory" - ) allSubDirs; - - hasScrollNix = dir: - let - scrollPath = scrollsDir + "/${dir}/scroll.nix"; - in builtins.pathExists scrollPath; - - scrollDirs = builtins.filter hasScrollNix directoriesOnly; - missingScrollDirs = builtins.filter (dir: !(hasScrollNix dir)) directoriesOnly; - - warnings = - if builtins.length missingScrollDirs > 0 - then builtins.trace - "Warning: Found directories without scroll.nix: ${builtins.toString missingScrollDirs}" - null - else null; -in -scrollDirs diff --git a/nix/website.nix b/nix/website.nix deleted file mode 100644 index fc3dbc8..0000000 --- a/nix/website.nix +++ /dev/null @@ -1,78 +0,0 @@ -{ pkgs, root }: -pkgs.stdenv.mkDerivation { - name = "grimu-r-website"; - - src = pkgs.lib.cleanSourceWith { - src = root; - filter = path: type: - let - baseName = baseNameOf path; - relativePath = pkgs.lib.removePrefix (toString root + "/") (toString path); - in - baseName == "README.org" || - relativePath == "website" || - pkgs.lib.hasPrefix "website/" relativePath; - }; - buildInputs = [ pkgs.pandoc ]; - - buildPhase = '' - cp $src/website/pandoc-template.html ./ - mkdir -p ./html/doc - cp $src/website/favicon.ico ./html/ - cp $src/website/llms.txt ./html/ - - if [ -d "$src/website/doc" ]; then - echo '' >> docs-nav.html - fi - - if [ -d "$src/website/doc" ]; then - for file in $src/website/doc/*.org; do - basename=$(basename "$file" .org) - pandoc \ - --template=./pandoc-template.html \ - --include-before-body=./docs-nav.html \ - --shift-heading-level-by=1 \ - --section-divs \ - -M document-css=false \ - "$file" \ - -o "./html/doc/$basename.html" - done - fi - - pandoc \ - --template=./pandoc-template.html \ - --shift-heading-level-by=1 \ - --section-divs \ - -M document-css=false \ - $src/README.org \ - -o html/index.html - - pandoc \ - --template=./pandoc-template.html \ - --shift-heading-level-by=1 \ - --section-divs \ - -M document-css=false \ - $src/website/pitch.org \ - -o html/pitch.html - ''; - - installPhase = '' - mkdir -p $out/html - mkdir -p $out/bin - cp -r ./html $out/ - - cat > $out/bin/grimu-r-website </dev/null | while read -r file; do + if ${pkgs.jq}/bin/jq empty "$file" 2>/dev/null; then + ${pkgs.jq}/bin/jq -S . "$file" > "$file.tmp" && mv "$file.tmp" "$file" + fi + done + + echo 'sourceContentHash: ${sourceContentHash}' + echo "" + echo "add me to knownHashes if you see a fake sha256 error ^" + echo "DON'T USE JSR DEPS UNLESS YOU MAKE THEM REPRODUCIBLE SOMEHOW" + echo "" + ''; + + installPhase = "true"; + + outputHashMode = "recursive"; + outputHashAlgo = "sha256"; + # this is basically FOD on steroids cause it + # deliberately breaks on relevant source changes + inherit outputHash; + }; + +in +{ + cache = unifiedCache; +} diff --git a/shelf/deno/hjq/deno.lock b/shelf/deno/hjq/deno.lock index ea94b66..e903f12 100644 --- a/shelf/deno/hjq/deno.lock +++ b/shelf/deno/hjq/deno.lock @@ -1,26 +1,15 @@ { - "version": "5", + "version": "4", "specifiers": { - "npm:@types/node@*": "22.13.4", "npm:hjson@^3.2.2": "3.2.2", "npm:jq-web@~0.6.2": "0.6.2" }, "npm": { - "@types/node@22.13.4": { - "integrity": "sha512-ywP2X0DYtX3y08eFVx5fNIw7/uIv8hYUKgXoK8oayJlLnKcRfEYCxWMVE1XagUdVtCJlZT1AU4LXEABW+L1Peg==", - "dependencies": [ - "undici-types" - ] - }, "hjson@3.2.2": { - "integrity": "sha512-MkUeB0cTIlppeSsndgESkfFD21T2nXPRaBStLtf3cAYA2bVEFdXlodZB0TukwZiobPD1Ksax5DK4RTZeaXCI3Q==", - "bin": true + "integrity": "sha512-MkUeB0cTIlppeSsndgESkfFD21T2nXPRaBStLtf3cAYA2bVEFdXlodZB0TukwZiobPD1Ksax5DK4RTZeaXCI3Q==" }, "jq-web@0.6.2": { "integrity": "sha512-+7XvjBYwTx4vP5PYkf6Q6orubO/v+UgMU6By1GritrmShr9QpT3UKa4ANzXWQfhdqtBnQYXsm7ZNbdIHT6tYpQ==" - }, - "undici-types@6.20.0": { - "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==" } }, "workspace": { diff --git a/shelf/deno/hjq/scroll.nix b/shelf/deno/hjq/scroll.nix new file mode 100644 index 0000000..accdc03 --- /dev/null +++ b/shelf/deno/hjq/scroll.nix @@ -0,0 +1,25 @@ +{ + name = "hjq"; + + description = "Drop-in jq replacement for HJSON that tries to preserve comments"; + + inputs = { + stdin = { + format = "HJSON"; + react = "push"; + }; + jq_filter = { + format = "string"; + react = "push"; + }; + }; + + outputs = { + stdout = { + format = "HJSON"; + react = "push"; + }; + }; + + cache-command = "deno cache --reload main.ts"; +} diff --git a/shelf/deno/uses-hjq/deno.json b/shelf/deno/uses-hjq/deno.json index 881c23c..b7d93f4 100644 --- a/shelf/deno/uses-hjq/deno.json +++ b/shelf/deno/uses-hjq/deno.json @@ -2,7 +2,7 @@ "tasks": { "start": "deno run --cached-only main.ts" }, - "links": [ + "patch": [ "../hjq" ] } diff --git a/shelf/deno/uses-hjq/deno.lock b/shelf/deno/uses-hjq/deno.lock index 033d446..e9382a1 100644 --- a/shelf/deno/uses-hjq/deno.lock +++ b/shelf/deno/uses-hjq/deno.lock @@ -1,26 +1,15 @@ { - "version": "5", + "version": "4", "specifiers": { - "npm:@types/node@*": "22.13.4", "npm:hjson@^3.2.2": "3.2.2", "npm:jq-web@~0.6.2": "0.6.2" }, "npm": { - "@types/node@22.13.4": { - "integrity": "sha512-ywP2X0DYtX3y08eFVx5fNIw7/uIv8hYUKgXoK8oayJlLnKcRfEYCxWMVE1XagUdVtCJlZT1AU4LXEABW+L1Peg==", - "dependencies": [ - "undici-types" - ] - }, "hjson@3.2.2": { - "integrity": "sha512-MkUeB0cTIlppeSsndgESkfFD21T2nXPRaBStLtf3cAYA2bVEFdXlodZB0TukwZiobPD1Ksax5DK4RTZeaXCI3Q==", - "bin": true + "integrity": "sha512-MkUeB0cTIlppeSsndgESkfFD21T2nXPRaBStLtf3cAYA2bVEFdXlodZB0TukwZiobPD1Ksax5DK4RTZeaXCI3Q==" }, "jq-web@0.6.2": { "integrity": "sha512-+7XvjBYwTx4vP5PYkf6Q6orubO/v+UgMU6By1GritrmShr9QpT3UKa4ANzXWQfhdqtBnQYXsm7ZNbdIHT6tYpQ==" - }, - "undici-types@6.20.0": { - "integrity": "sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==" } } } diff --git a/shelf/deno/uses-hjq/scroll.nix b/shelf/deno/uses-hjq/scroll.nix index 974d5ac..5faee5e 100644 --- a/shelf/deno/uses-hjq/scroll.nix +++ b/shelf/deno/uses-hjq/scroll.nix @@ -1,27 +1,3 @@ { - name = "uses-hjq"; - - description = "A test scroll that mimicks hjq's behavior"; - - inputs = { - stdin = { - format = "HJSON"; - react = "push"; - }; - jqFilter = { - format = "string"; - react = "push"; - }; - }; - - outputs = { - stdout = { - format = "HJSON"; - react = "push"; - }; - }; - - build = { - lockFile = ./deno.lock; - }; + cache-command = "deno cache -I --reload main.ts"; } diff --git a/vocabulary.org b/vocabulary.org new file mode 100644 index 0000000..1a61401 --- /dev/null +++ b/vocabulary.org @@ -0,0 +1,44 @@ +:PROPERTIES: +:ID: 00790dad-7881-4252-8951-23f770e3f070 +:END: +#+BEGIN_EXPORT html + +#+END_EXPORT +#+title: Grimu-R vocabulary + +** Weave +Defines a collection of ornaments. +Can assign one weave as default. +** Ornament +Has reactive inputs and outputs. +Serves as an externally invocable entry point. +Contains spells or nested ornaments. +** Spell +Has reactive inputs and outputs. +Atomic execution unit. +Cannot be directly invoked externally. +May have an inscription. +Created from a scroll and executed in its runtime environment. +** Stitch +Connects a reactive input to a compatible reactive output. +** Inscription +Defines code in a scripting language to be ran when the corresponding spell is executed. +** Scroll +Defines source code, its build dependencies and runtime environment. +Provides a default spell configuration. +** Shelf +Contains all the scrolls defined in a project as well as its dependencies. +** Edition +Represents a weave as a compiled program. +** Loom +Provisions tools for interactive or programmatic weaving. diff --git a/website/doc/glossary.org b/website/doc/glossary.org deleted file mode 100644 index 70e9bc3..0000000 --- a/website/doc/glossary.org +++ /dev/null @@ -1,46 +0,0 @@ -#+title: Grimu-R glossary - -* Weave -Defines a collection of braids. -Represented by files on disk. -* Braid -Has reactive inputs and outputs. -Serves as an externally invocable entry point. -Contains sigils and/or nested braid instances connected by strands. -Can be distributed within a schism aspect. -* Sigil -Has reactive inputs and outputs. -Atomic execution unit. -Cannot be directly invoked by an aspect consumer. -May have an inscription. -Created from a scroll and executed in the grimoire environment. -* Strand -Connects a reactive input to a compatible reactive output. -Can be cadence-decorated on both upstream and downstream ends. -May be parameterized by a reactive input, consuming variable assignments for the cadence decoration. -* Cadence -Defines reactive behavior. -May refer to variables defined by the reactive input. -* Inscription -Defines a script, a template or a configuration for a sigil to be executed with. -May be defined statically in the weave or considered a reactive input. -* Scroll -Defines source code, its build dependencies and runtime environment. -Provides a default sigil configuration. -Provides default upstream/downstream cadence decorators for outputs/inputs respectively. -Declares runtime compatibility (browser-only, non-browser, or universal). -* Grimoire -Complete environment required to execute (a part of) a weave. -* Schism -Splits the weave by grouping its braids into coherent collections of aspects. -* Aspect -Represents a collection of entire braids as an individual program. -Uses rifts to communicate with other aspects within the same schism. -* Rift -Acts as a proxy for a braid instance that was separated into a different aspect. -Enables strands to cross process and network boundaries. -* Binding -Provides a build strategy for a schism. -Maps an aspect to a specific build recipe producing an executable or a container. -* Loom -Provisions tools for interactive or programmatic weaving and execution. diff --git a/website/doc/weaving_guide.org b/website/doc/weaving_guide.org deleted file mode 100644 index 60d920d..0000000 --- a/website/doc/weaving_guide.org +++ /dev/null @@ -1,35 +0,0 @@ -#+title: Grimu-R lifecycle guide - -* Project initialization -- create your flake -- add Grimu-R base as input -- define and enter a dev shell -* Interactive weaving -- open Loom editor in the browser -- create a braid -- add sigils to it from the scrolls palette -- connect them with strands -- edit sigil inscriptions -- execute sigils by clicking on their buttons -- adjust cadence decoration -* Modular weaving -- factor out braids -- define your own scrolls -- import external scrolls and weaves as flake inputs -- export yours as flake outputs -- call braids from other programs -* Deployment pipeline -- define a schism with aspects containing braids -- define a binding -- build executables / containers -* User-side weaving (malleability) -- add Loom to the binding definition -- deploy the executable -- open Loom editor in the browser -- persist edits in the browser -- rebase persisted edits on top of new versions released by devs -* Testing and test automation -- use Loom in the browser to run and inspect interactively -- define test data right in the weave as static sigils -- extract test data from the weave with Loom CLI -- execute braids with test inputs with Loom CLI diff --git a/website/favicon.ico b/website/favicon.ico deleted file mode 100644 index 91952a8..0000000 Binary files a/website/favicon.ico and /dev/null differ diff --git a/website/llms.txt b/website/llms.txt deleted file mode 100644 index 59af071..0000000 --- a/website/llms.txt +++ /dev/null @@ -1,60 +0,0 @@ -# Grimu-R - -**Grimu-R** is an open-source framework for mixed visual-textual dataflow scripting, combining interactive web-based visual editing with polyglot scripting runtime. - -## Core Concepts - -**Weave**: A Git-friendly project representation containing the complete dataflow graph and layout -**Braid**: Reusable modules/entry points that can be nested and serve as CLI subcommands or RPC methods -**Sigil**: Basic building blocks - programs that act as data sources, sinks, or transformers -**Scroll**: Defines runtime environment and default configuration for sigils (developed with Nix) -**Inscription**: Dynamic scripts/templates stored in weaves, editable in the visual editor -**Strand**: Connects reactive inputs/outputs with configurable cadence decorators -**Schism/Aspect**: Splits weaves into deployable program collections -**Loom**: Interactive weaving and execution tools - -## Key Features - -- **Visual-textual editor**: Browser-based with immediate feedback and live code changes -- **Reactive dataflow**: Granular configuration for push/pull, throttling, batching, backpressure -- **Polyglot**: Real code blocks in familiar languages leveraging their ecosystems -- **Nix-powered**: Reproducible builds and environments with minimal setup effort -- **Malleable**: End users can inspect/modify dataflows using the same editor as developers -- **Embeddable**: Builds to CLI tools, RPC servers, web apps, or containers -- **Cross-language**: Structured data (JSON lines) connections between different runtimes - -## Development Workflow - -1. **Project setup**: Create Nix flake with Grimu-R base, enter dev shell -2. **Interactive weaving**: Use browser-based Loom editor to create braids, add sigils, connect with strands -3. **Modular development**: Factor out reusable braids, define custom scrolls, import/export as flake inputs/outputs -4. **Testing**: Run interactively in browser, define test data as static sigils, extract/execute via Loom CLI -5. **Deployment**: Define schisms with aspects, create bindings, build executables/containers - -## Use Cases - -- Rapid prototyping of data processing pipelines -- Self-hosted workflow automation -- Custom dashboards with complex logic -- Internal tooling and automation scripts -- Hacker-friendly, highly customizable applications - -## Positioning - -Takes the best from visual programming environments, script automation, and code notebooks while remaining developer-first. Avoids limitations of proprietary tools, brittleness of script bundles, and opacity of notebooks. - -## Licensing - -- **Platform components** (Loom tools, weave executors): AGPL v3 -- **Base scrolls and non-platform code**: MIT -- AGPL applies to forks/extensions of platform code and SaaS deployments -- Your weaves and applications using Grimu-R are not affected by AGPL terms - -## Technical Notes - -- Development environment provisioned via Nix shell -- Visual editor communicates over WebSocket -- Changes stored in browser, exportable as files -- Cross-language via structured data pipes (like Unix pipes with JSON) -- Shared runtime dependencies managed by Nix -- Malleability limited to client-side parts in client-server applications diff --git a/website/pandoc-template.html b/website/pandoc-template.html deleted file mode 100644 index f1d6ef1..0000000 --- a/website/pandoc-template.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - $if(title)$ - $title$ - $endif$ - - - -
-
-

$title$

-
- home - docs - pitch deck - llms -
-
-
-
- $for(include-before)$ - $include-before$ - $endfor$ -
-
- $body$ -
-
-
- - diff --git a/website/pitch.org b/website/pitch.org deleted file mode 100644 index f7fb780..0000000 --- a/website/pitch.org +++ /dev/null @@ -1,53 +0,0 @@ -#+title: Grimu-R pitch deck -* Key benefits -** Rapid prototyping -- Visual development and debugging -- Executed directly on dev's machine -- Immediate feedback -** Flexibility -- Not just workflows and dashboards -- anything -- Embed existing software into a Grimu-R project -- Embed a Grimu-R project itself into a larger flow -- No inherent deployment limitations, execute anywhere -** Clear evolution and hardening path -- Start with a visual, interactive prototype -- Decompose into components -- Add builds and deployments -- Call Grimu-R components from non Grimu-R components -- Automate testing -** Malleability -- Power users have the same superpowers as developers -- Can inspect, modify and extend available components in the visual editor -- Highly adaptable, customizable internal tooling -** No more "works on my machine" -- Reproducible environments and builds with Nix -- Every developer has the same tooling installed automatically -** Knowledge transfer -- Visual flow gives a clear overview and facilitates dev onboarding -- Execution graphs are self-documenting, serving both as code and a diagram for it -- Easier participation for less technical team members -** Reusable modules -- Base library components and integrations -- An open ecosystem of third-party utilities, open-source and commercial -- Develop and sell your own modules, or open source and get community support -** Free as in freedom -- The Grimu-R platform is open source, can be employed and extended freely -- Works on your machines, not in some cloud you don't control -* Caveats -** Bespoke reactive dataflow graphs and tooling -- Developers and power users need to get familiar with the mental model and tools -- General, intuitive concepts but still unorthodox -- Nifty and precise but alien jargon -** Nix -- Steep learning curve for developing your own components -- Hated by a huge % of devs -- There are limited ways to opt out -** Performance overhead -- Visual/textual scripts are fast to create, slow to execute -- Compiled binaries can be used at the cost of some convenience -- Deployable bundles are huge in volume -- No single "blessed" way to scale (yet) -** Copyleft licensing -- The platform can be extended, and contributions are welcome -- But your contributions must also be open source -- Only applies to the platform -- not components and modules!