diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..330d05a --- /dev/null +++ b/COPYING @@ -0,0 +1,37 @@ +Psylon - Licensing +================== + +Psylon is a Pylon v2 fork maintained by Netsnek e. U. + +The canonical public repository is located at: + https://github.com/netsnek/psylon + +Copyright (c) 2024 Netsnek e. U. and contributors. +Based on work Copyright (c) 2024 Nico Schett . + +This project is provided under: + + SPDX-License-Identifier: EUPL-1.2 + +The Psylon project as a whole is distributed under the terms of the European Union +Public Licence version 1.2, as reproduced in: + + LICENSES/preferred/EUPL-1.2 + +This project also includes upstream code originally licensed under the +Apache License, Version 2.0, which remains available under that licence. +For those parts, see: + + LICENSES/upstream/Apache-2.0 + and the original file headers. + +Changes +------- + +Psylon is a Pylon v2 fork, tuned to behave like its predecessor snek-functions +and laser-focused on seamless microservice interoperability. + +Unlike Pylon v3, which aims to become a full-stack framework, Psylon is and +will remain a GraphQL-based microservice framework. Security fixes and +compatible behavioural changes from Pylon v3 that improve the v2 runtime will +be backported to Psylon where appropriate. diff --git a/LICENSES/preferred/EUPL-1.2 b/LICENSES/preferred/EUPL-1.2 new file mode 100644 index 0000000..433a78a --- /dev/null +++ b/LICENSES/preferred/EUPL-1.2 @@ -0,0 +1,291 @@ +Valid-License-Identifier: EUPL-1.2 +SPDX-URL: https://spdx.org/licenses/EUPL-1.2.html +Usage-Guide: + To use this license in source code, put one of the following SPDX + tag/value pairs into a comment according to the placement + guidelines in the licensing rules documentation. + For 'European Union Public Licence (EUPL) version 1.2 only' use: + SPDX-License-Identifier: EUPL-1.2 +License-Text: + +European Union Public Licence +V. 1.2 + +Copyright © 2019-2025 Netsnek e. U. + +Everyone is permitted to copy and distribute verbatim copies +of this license document, but changing it is not allowed. + +This Software, Data and, or Configurations are distributed under the terms of the "European Union Public Licence V. 1.2". + +EUPL © the European Union 2007, 2016 + +This European Union Public Licence (the ‘EUPL’) applies to the Work (as +defined below) which is provided under the terms of this Licence. Any use of +the Work, other than as authorised under this Licence is prohibited (to the +extent such use is covered by a right of the copyright holder of the Work). + +The Work is provided under the terms of this Licence when the Licensor (as +defined below) has placed the following notice immediately following the +copyright notice for the Work: “Licensed under the EUPL”, or has expressed by +any other means his willingness to license under the EUPL. + +1. Definitions + +In this Licence, the following terms have the following meaning: +— ‘The Licence’: this Licence. +— ‘The Original Work’: the work or software distributed or communicated by the + ‘Licensor under this Licence, available as Source Code and also as + ‘Executable Code as the case may be. +— ‘Derivative Works’: the works or software that could be created by the + ‘Licensee, based upon the Original Work or modifications thereof. This + ‘Licence does not define the extent of modification or dependence on the + ‘Original Work required in order to classify a work as a Derivative Work; + ‘this extent is determined by copyright law applicable in the country + ‘mentioned in Article 15. +— ‘The Work’: the Original Work or its Derivative Works. +— ‘The Source Code’: the human-readable form of the Work which is the most + convenient for people to study and modify. + +— ‘The Executable Code’: any code which has generally been compiled and which + is meant to be interpreted by a computer as a program. +— ‘The Licensor’: the natural or legal person that distributes or communicates + the Work under the Licence. +— ‘Contributor(s)’: any natural or legal person who modifies the Work under + the Licence, or otherwise contributes to the creation of a Derivative Work. +— ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of + the Work under the terms of the Licence. +— ‘Distribution’ or ‘Communication’: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, online or offline, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, +sublicensable licence to do the following, for the duration of copyright +vested in the Original Work: + +— use the Work in any circumstance and for all usage, +— reproduce the Work, +— modify the Work, and make Derivative Works based upon the Work, +— communicate to the public, including the right to make available or display + the Work or copies thereof to the public and perform publicly, as the case + may be, the Work, +— distribute the Work or copies thereof, +— lend and rent the Work or copies thereof, +— sublicense rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make +effective the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non-exclusive usage rights +to any patents held by the Licensor, to the extent necessary to make use of +the rights granted on the Work under this Licence. + +3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, +in a notice following the copyright notice attached to the Work, a repository +where the Source Code is easily and freely accessible for as long as the +Licensor continues to distribute or communicate the Work. + +4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits +from any exception or limitation to the exclusive rights of the rights owners +in the Work, of the exhaustion of those rights or of other applicable +limitations thereto. + +5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: The Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and +a copy of the Licence with every copy of the Work he/she distributes or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes or communicates copies of the +Original Works or Derivative Works, this Distribution or Communication will be +done under the terms of this Licence or of a later version of this Licence +unless the Original Work is expressly distributed only under this version of +the Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee +(becoming Licensor) cannot offer or impose any additional terms or conditions +on the Work or Derivative Work that alter or restrict the terms of the +Licence. + +Compatibility clause: If the Licensee Distributes or Communicates Derivative +Works or copies thereof based upon both the Work and another work licensed +under a Compatible Licence, this Distribution or Communication can be done +under the terms of this Compatible Licence. For the sake of this clause, +‘Compatible Licence’ refers to the licences listed in the appendix attached to +this Licence. Should the Licensee's obligations under the Compatible Licence +conflict with his/her obligations under this Licence, the obligations of the +Compatible Licence shall prevail. + +Provision of Source Code: When distributing or communicating copies of the +Work, the Licensee will provide a machine-readable copy of the Source Code or +indicate a repository where this Source will be easily and freely available +for as long as the Licensee continues to distribute or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade +names, trademarks, service marks, or names of the Licensor, except as required +for reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she +brings to the Work are owned by him/her or licensed to him/her and that he/she +has the power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +Contributors. It is not a finished work and may therefore contain defects or +‘bugs’ inherent to this type of development. + +For the above reason, the Work is provided under the Licence on an ‘as is’ +basis and without warranties of any kind concerning the Work, including +without limitation merchantability, fitness for a particular purpose, absence +of defects or errors, accuracy, non-infringement of intellectual property +rights other than copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a +condition for the grant of any rights to the Work. + +8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the +use of the Work, including without limitation, damages for loss of goodwill, +work stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such +damage. However, the Licensor will be liable under statutory product liability +laws as far such laws apply to the Work. + +9. Additional agreements + +While distributing the Work, You may choose to conclude an additional +agreement, defining obligations or services consistent with this Licence. +However, if accepting obligations, You may act only on your own behalf and on +your sole responsibility, not on behalf of the original Licensor or any other +Contributor, and only if You agree to indemnify, defend, and hold each +Contributor harmless for any liability incurred by, or claims asserted against +such Contributor by the fact You have accepted any warranty or additional +liability. + +10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon ‘I +agree’ placed under the bottom of a window displaying the text of this Licence +or by affirming consent in any other similar way, in accordance with the rules +of applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this +Licence, such as the use of the Work, the creation by You of a Derivative Work +or the Distribution or Communication by You of the Work or copies thereof. + +11. Information to the public + +In case of any Distribution or Communication of the Work by means of +electronic communication by You (for example, by offering to download the Work +from a remote location) the distribution channel or media (for example, a +website) must at least provide to the public the information requested by the +applicable law regarding the Licensor, the Licence and the way it may be +accessible, concluded, stored and reproduced by the Licensee. + +12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. Such a termination +will not terminate the licences of any person who has received the Work from +the Licensee under the Licence, provided such persons remain in full +compliance with the Licence. + +13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed or reformed so as necessary to make it +valid and enforceable. + +The European Commission may publish other linguistic versions or new versions +of this Licence or updated versions of the Appendix, so far this is required +and reasonable, without reducing the scope of the rights granted by the +Licence. New versions of the Licence will be published with a unique version +number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +14. Jurisdiction + +Without prejudice to specific agreement between parties, +— any litigation resulting from the interpretation of this License, arising + between the European Union institutions, bodies, offices or agencies, as a + Licensor, and any Licensee, will be subject to the jurisdiction of the Court + of Justice of the European Union, as laid down in article 272 of the Treaty + on the Functioning of the European Union, +— any litigation arising between other parties and resulting from the + interpretation of this License, will be subject to the exclusive + jurisdiction of the competent court where the Licensor resides or conducts + its primary business. + +15. Applicable Law + +Without prejudice to specific agreement between parties, +— this Licence shall be governed by the law of the European Union Member State + where the Licensor has his seat, resides or has his registered office, +— this licence shall be governed by Belgian law if the Licensor has no seat, + residence or registered office inside a European Union Member State. + +Appendix + +‘Compatible Licences’ according to Article 5 EUPL are: +— GNU General Public License (GPL) v. 2, v. 3 +— GNU Affero General Public License (AGPL) v. 3 +— Open Software License (OSL) v. 2.1, v. 3.0 +— Eclipse Public License (EPL) v. 1.0 +— CeCILL v. 2.0, v. 2.1 +— Mozilla Public Licence (MPL) v. 2 +— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3 +— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for + works other than software +— European Union Public Licence (EUPL) v. 1.1, v. 1.2 +— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or + Strong Reciprocity (LiLiQ-R+) + +— The European Commission may update this Appendix to later versions of the + above licences without producing a new version of the EUPL, as long as they + provide the rights granted in Article 2 of this Licence and protect the + covered Source Code from exclusive appropriation. +— All other changes or additions to this Appendix require the production of a + new EUPL version. diff --git a/LICENSES/upstream/Apache-2.0 b/LICENSES/upstream/Apache-2.0 new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSES/upstream/Apache-2.0 @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md deleted file mode 120000 index 543804d..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -packages/pylon/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c84cb0 --- /dev/null +++ b/README.md @@ -0,0 +1,215 @@ +

+ + SNEK Logo + +

+ + +
Psylon
+
The next generation of building APIs.
Automatic schema generation for your service logic.
+
+
+Website + · +GitHub + · +Discord + +
+
+ +[![Documentation](https://img.shields.io/badge/documentation-documentation?color=000000)](https://pylon.cronit.io/docs) +[![NPM](https://img.shields.io/npm/v/psylon)](https://www.npmjs.com/package/psylon) +[![Discord](https://img.shields.io/discord/1270327745662029854)](https://discord.com/invite/cbJjkVrnHe) + +
+ +## Introduction + +A framework for building GraphQL APIs without defining any kind of schema. +It reduces the time spent on writing and maintaining API definitions, allowing you to focus solely on writing your service logic. + +## Why + +We believe that the current approach to building APIs is outdated. Writing and maintaining API definitions is time-consuming and error-prone. When you already have TypeScript definitions, why not use them to infer the API schema? Psylon does exactly that. + +Psylon also provides a set of tools to help you build, test, and deploy your APIs. We believe that building services should be easy and fun. Major functionalities like authentication, authorization, and context management are built-in, so you can focus on what matters most: your service logic. + +With Psylon, you can build APIs faster, with fewer errors, and with less code. + +## About + +Psylon is a Pylon v2 fork maintained by Netsnek e. U., tuned to behave like its +predecessor snek-functions and laser-focused on seamless microservice interoperability. + +Unlike Pylon v3, which aims to become a full-stack framework, Psylon is and will +remain a GraphQL-based microservice framework. Security fixes and compatible +behavioural changes from Pylon v3 that improve the v2 runtime will be backported +to Psylon where appropriate. + +Canonical repository: https://github.com/netsnek/psylon + +## Roadmap + +Psylons roadmap is centered around GraphQL via GQty and its pgqty fork. +For current plans and discussion, see +[gqty-dev/gqty#2051](https://github.com/gqty-dev/gqty/issues/2051). + +## Create + +To create a new Psylon project, run the following command: + +```bash +npm create psylon@latest +``` + +Afterwards, you can navigate to the newly created project and start the development server: + +```bash +cd my-psylon +npm run dev +``` + +This will start the development server on `http://localhost:3000`. + +Open the [Psylon Playground](https://pylon.cronit.io/docs/getting-started#built-in-graphql-playground) in your browser and start building your API. + +## Develop + +Update your service logic in the `src` directory. + +```typescript +import {app} from 'psylon' + +export const graphql = { + Query: { + user: (id: string) => { + return { + id, + name: 'John Doe', + email: 'johndoe@example.com' + } + }, + products: () => [ + {id: '1', name: 'Laptop', price: 999.99}, + {id: '2', name: 'Smartphone', price: 499.99}, + {id: '3', name: 'Tablet', price: 299.99} + ] + }, + Mutation: { + updateUserEmail: (id: string, newEmail: string) => { + return { + id, + email: newEmail + } + }, + createOrder: (userId: string, productIds: string[]) => { + return { + id: 'order-123', + userId, + productIds, + status: 'PENDING' + } + } + } +} + +export default app +``` + +**Query:** + +```graphql +query GetUser { + user(id: "1") { + id + name + email + } +} + +query GetProducts { + products { + id + name + price + } +} +``` + +**Mutation:** + +```graphql +mutation UpdateUserEmail { + updateUserEmail(id: "1", newEmail: "johndoe2@example.com") { + id + email + } +} + +mutation CreateOrder { + createOrder(userId: "1", productIds: ["1", "2"]) { + id + userId + productIds + status + } +} +``` + +## Deploy + +Psylon is fully compatible with Cloudflare Workers, allowing you to deploy your service to the edge in just one minute. +Watch the video below to see how easy it is to deploy a Psylon. + +![Cloudflare Workers](https://github.com/user-attachments/assets/8e9f96a7-47e3-4c66-8426-fe09329de598) + +If you prefer to deploy your service to a different platform, you can use the provided Dockerfile to build a Docker image and deploy it to your favorite cloud provider. + +```bash +docker build -t my-pylon . +docker run -p 3000:3000 my-pylon +``` + +## Runtimes + +Designed to be flexible, Psylon can be run on various platforms, including: + +| Bun.js logo | Node.JS | Gmail logo | Deno logo | +| :------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------- | +| Bun.js | Node.js | Cloudflare Workers | Deno | + +## Features + +Psylon offers a comprehensive set of features to streamline the development of modern web services: + +| Feature | Description | +| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| **Automatic Schema Generation** | Psylon generates GraphQL schemas based on your TypeScript definitions, ensuring type safety and reducing manual coding effort. | +| **Type Safety** | By leveraging TypeScript, Psylon ensures that your services are type-safe, catching errors at compile time. | +| **Authentication and Authorization** | Built-in support for OIDC standard and integration with ZITADEL for managing user authentication and role-based access control. | +| **Logging and Monitoring** | Sentry for error tracking, providing robust monitoring capabilities. | +| **Database Integration** | Seamlessly works with Prisma to generate extended models that support automatic resolution of relations and paginatable connections. | +| **Deployment Ready** | Includes pre-configured Dockerfile for easy deployment using Docker or manual methods. | + +## Playground + +You can try Psylon in the [Playground](https://pylon.cronit.io/playground) without installing anything. +Or simply click the image below to open the Playground. + +[![Playground](https://github.com/user-attachments/assets/39df08d0-4094-4836-a36b-37ad62e292cf)](https://pylon.cronit.io/playground) + +## Contributing + +Documentation, bug reports, pull requests, and other contributions are welcomed! +See [`CONTRIBUTING.md`](CONTRIBUTING.md) for more information. + +## Support + +- **Community Support:** Join the Psylon community on GitHub to report bugs and request features. +- **Professional Support:** For professional support and consulting services, contact [office@cronit.io](mailto:office@cronit.io). +- Join the [Psylon Discord server](https://discord.gg/cbJjkVrnHe) to connect with other users and contributors. + +--- + +Psylon is brought to you by Cronit. diff --git a/docs/components/authors.tsx b/docs/components/authors.tsx index 4cd768c..49e0a0a 100644 --- a/docs/components/authors.tsx +++ b/docs/components/authors.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + export default function Authors({date, children}) { return (
diff --git a/docs/components/callout.tsx b/docs/components/callout.tsx index 8a09210..7176d8b 100644 --- a/docs/components/callout.tsx +++ b/docs/components/callout.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import clsx from 'clsx' import {Icon} from './icon' diff --git a/docs/components/clipboard-button.tsx b/docs/components/clipboard-button.tsx index cc0c283..2b78d00 100644 --- a/docs/components/clipboard-button.tsx +++ b/docs/components/clipboard-button.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + 'use client' import {useState} from 'react' diff --git a/docs/components/counters.tsx b/docs/components/counters.tsx index 2d0bc6e..a0e4fd4 100644 --- a/docs/components/counters.tsx +++ b/docs/components/counters.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + // Example from https://beta.reactjs.org/learn import {useState} from 'react' diff --git a/docs/components/features.tsx b/docs/components/features.tsx index ad6b6ab..0cba213 100644 --- a/docs/components/features.tsx +++ b/docs/components/features.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {useId} from 'react' import styles from './features.module.css' diff --git a/docs/components/icon.tsx b/docs/components/icon.tsx index 2f1e729..9975833 100644 --- a/docs/components/icon.tsx +++ b/docs/components/icon.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {SVGProps, useId} from 'react' import clsx from 'clsx' diff --git a/docs/components/icons/InstallationIcon.tsx b/docs/components/icons/InstallationIcon.tsx index 954dcf1..c140804 100644 --- a/docs/components/icons/InstallationIcon.tsx +++ b/docs/components/icons/InstallationIcon.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {DarkMode, Gradient, LightMode} from '../icon' export const InstallationIcon: React.FC<{ diff --git a/docs/components/icons/LightbulbIcon.tsx b/docs/components/icons/LightbulbIcon.tsx index e73978c..ef975f3 100644 --- a/docs/components/icons/LightbulbIcon.tsx +++ b/docs/components/icons/LightbulbIcon.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {DarkMode, Gradient, LightMode} from '../icon' export const LightbulbIcon: React.FC<{ diff --git a/docs/components/icons/PluginsIcon.tsx b/docs/components/icons/PluginsIcon.tsx index 9902393..f9b7389 100644 --- a/docs/components/icons/PluginsIcon.tsx +++ b/docs/components/icons/PluginsIcon.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {DarkMode, Gradient, LightMode} from '../icon' export const PluginsIcon: React.FC<{ diff --git a/docs/components/icons/PresetsIcon.tsx b/docs/components/icons/PresetsIcon.tsx index 53d34f2..d38b725 100644 --- a/docs/components/icons/PresetsIcon.tsx +++ b/docs/components/icons/PresetsIcon.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {DarkMode, Gradient, LightMode} from '../icon' export const PresetsIcon: React.FC<{ diff --git a/docs/components/icons/ThemingIcon.tsx b/docs/components/icons/ThemingIcon.tsx index a3d9d81..dc72f32 100644 --- a/docs/components/icons/ThemingIcon.tsx +++ b/docs/components/icons/ThemingIcon.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {DarkMode, Gradient, LightMode} from '../icon' export const ThemingIcon: React.FC<{ diff --git a/docs/components/icons/WarningIcon.tsx b/docs/components/icons/WarningIcon.tsx index 83d5238..50878fd 100644 --- a/docs/components/icons/WarningIcon.tsx +++ b/docs/components/icons/WarningIcon.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {DarkMode, Gradient, LightMode} from '../icon' export const WarningIcon: React.FC<{ diff --git a/docs/components/landing.tsx b/docs/components/landing.tsx index 72d590d..c82eee0 100644 --- a/docs/components/landing.tsx +++ b/docs/components/landing.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {useState, useEffect} from 'react' import Link from 'next/link' import Image from 'next/image' @@ -175,7 +178,7 @@ export function Landing() {
diff --git a/docs/components/logo.tsx b/docs/components/logo.tsx index 6e73f4d..b24d26d 100644 --- a/docs/components/logo.tsx +++ b/docs/components/logo.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {cn} from '@lib/utils' const Logo: React.FC<{className?: string}> = props => { diff --git a/docs/components/page-preview-card.tsx b/docs/components/page-preview-card.tsx index bb61601..132966c 100644 --- a/docs/components/page-preview-card.tsx +++ b/docs/components/page-preview-card.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {MdxFile, Meta} from 'nextra' import {Link} from 'nextra-theme-docs' import { diff --git a/docs/components/playground.tsx b/docs/components/playground.tsx index e40f1fb..198cc26 100644 --- a/docs/components/playground.tsx +++ b/docs/components/playground.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + export const Playground: React.FC = () => { return (
diff --git a/docs/components/quick-link/index.tsx b/docs/components/quick-link/index.tsx index 8b0b2d5..8bb5ad2 100644 --- a/docs/components/quick-link/index.tsx +++ b/docs/components/quick-link/index.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {Icon, Icons} from '../icon' import {Link} from 'nextra-theme-docs' diff --git a/docs/components/ui/badge.tsx b/docs/components/ui/badge.tsx index 0952285..674b204 100644 --- a/docs/components/ui/badge.tsx +++ b/docs/components/ui/badge.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import * as React from 'react' import {cva, type VariantProps} from 'class-variance-authority' diff --git a/docs/components/ui/button.tsx b/docs/components/ui/button.tsx index ead7fc2..88b0a77 100644 --- a/docs/components/ui/button.tsx +++ b/docs/components/ui/button.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import * as React from 'react' import {Slot} from '@radix-ui/react-slot' import {cva, type VariantProps} from 'class-variance-authority' diff --git a/docs/components/ui/card.tsx b/docs/components/ui/card.tsx index 2e90a32..47204d3 100644 --- a/docs/components/ui/card.tsx +++ b/docs/components/ui/card.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import * as React from 'react' import {cn} from '@/lib/utils' diff --git a/docs/components/ui/glowing-stars-card.tsx b/docs/components/ui/glowing-stars-card.tsx index b792be1..a392e67 100644 --- a/docs/components/ui/glowing-stars-card.tsx +++ b/docs/components/ui/glowing-stars-card.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + 'use client' import React, {useEffect, useRef, useState} from 'react' diff --git a/docs/components/ui/hover-border-gradient.tsx b/docs/components/ui/hover-border-gradient.tsx index 8f885d5..8d197d8 100644 --- a/docs/components/ui/hover-border-gradient.tsx +++ b/docs/components/ui/hover-border-gradient.tsx @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + 'use client' import React, {useState, useEffect} from 'react' import {motion} from 'framer-motion' diff --git a/docs/lib/utils.ts b/docs/lib/utils.ts index 8fb87a3..8066a7a 100644 --- a/docs/lib/utils.ts +++ b/docs/lib/utils.ts @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + import {clsx, type ClassValue} from 'clsx' import {twMerge} from 'tailwind-merge' diff --git a/docs/next-env.d.ts b/docs/next-env.d.ts index 4f11a03..4d8cc66 100644 --- a/docs/next-env.d.ts +++ b/docs/next-env.d.ts @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + /// /// diff --git a/docs/next.config.js b/docs/next.config.js index b172428..d3aa910 100644 --- a/docs/next.config.js +++ b/docs/next.config.js @@ -1,3 +1,6 @@ +// Copyright 2024 Nico Schett +// SPDX-License-Identifier: Apache-2.0 + const withNextra = require('nextra')({ theme: 'nextra-theme-docs', themeConfig: './theme.config.tsx', diff --git a/docs/pages/blog/pylon-1.0.mdx b/docs/pages/blog/pylon-1.0.mdx index 9a6c25c..7bc60fd 100644 --- a/docs/pages/blog/pylon-1.0.mdx +++ b/docs/pages/blog/pylon-1.0.mdx @@ -48,7 +48,7 @@ Getting started with Pylon is a breeze: 1. **Install Pylon CLI:** Begin by installing the Pylon CLI globally: ```bash - npm install -g @getcronit/pylon-cli + npm install -g psylon-cli ``` 2. **Create a New Pylon Project:** Initialize a new project with: diff --git a/docs/pages/blog/pylon-2.0.mdx b/docs/pages/blog/pylon-2.0.mdx index 1fd5193..2346308 100644 --- a/docs/pages/blog/pylon-2.0.mdx +++ b/docs/pages/blog/pylon-2.0.mdx @@ -11,18 +11,18 @@ import Authors, {Author} from '@components/authors' -Welcome to `@getcronit/pylon@2.0.0` release (September 2024)! +Welcome to `psylon@2.0.0` release (September 2024)! Pylon v2 introduces the support for different runtimes, a new create command, and an improved development server. -The official supported runtimes by the `npm create pylon` command are Bun, Node.js and Cloudflare Workers. Other runtimes are also supported but require manual setup. +The official supported runtimes by the `npm create psylon` command are Bun, Node.js and Cloudflare Workers. Other runtimes are also supported but require manual setup. We’ve tried to make migration smooth. Please refer to the [migration guide](/docs/release-notes/migrating-from-v1-to-v2.mdx) and [let us know](https://github.com/getcronit/pylon/issues/new/choose) if you encounter any issues when migrating. Key highlights of this release: - **New Runtimes**: Pylon now supports multiple runtimes, including Bun, Node.js and Cloudflare Workers. -- **Unified Create Command**: The new `npm create pylon` command provides a consistent way to create new Pylon projects. +- **Unified Create Command**: The new `npm create psylon` command provides a consistent way to create new Pylon projects. - **Improved Development Server**: The new `pylon dev` command provides a unified development experience across different runtimes. -- **Drop of `pylon-cli` and `pylon-server`**: The `@getcronit/pylon-cli` and `@getcronit/pylon-server` packages are no longer required and replaced by the `@getcronit/pylon-dev` package. +- **Drop of `pylon-cli` and `pylon-server`**: The `psylon-cli` and `psylon-server` packages are no longer required and replaced by the `@netsnek/psylon-dev` package. ## Breaking Changes @@ -32,7 +32,7 @@ If you have any questions or need help, please don’t hesitate to [reach out to ## Overview Video -Watch how we use the new `npm create pylon` command to create a new Pylon project and deploy it to Cloudflare Workers in less than 1 minute: +Watch how we use the new `npm create psylon` command to create a new Pylon project and deploy it to Cloudflare Workers in less than 1 minute: