diff --git a/.changeset/soft-spies-swim.md b/.changeset/soft-spies-swim.md new file mode 100644 index 0000000..f74e1c9 --- /dev/null +++ b/.changeset/soft-spies-swim.md @@ -0,0 +1,5 @@ +--- +"wpgraphql-ide": patch +--- + +- **New Capability**: Introduced a new custom capability `manage_graphql_ide`. This capability allows administrators to control access to the WPGraphQL IDE functionalities. The capability has been assigned to the `administrator` role by default. diff --git a/.github/workflows/code-quality.yml b/.github/workflows/code-quality.yml new file mode 100644 index 0000000..2af0fab --- /dev/null +++ b/.github/workflows/code-quality.yml @@ -0,0 +1,46 @@ +name: Code Quality + +on: + push: + branches: + - main + pull_request: + branches: + - main + +# Cancel previous workflow run groups that have not completed. +concurrency: + # Group workflow runs by workflow name, along with the head branch ref of the pull request + # or otherwise the branch or tag ref. + group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.ref }} + cancel-in-progress: true + +jobs: + run: + runs-on: ubuntu-latest + name: Check code + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: 8.2 + tools: composer:v2 + coverage: none + + - name: Install dependencies + uses: ramsey/composer-install@v3 + with: + composer-options: "--no-progress" + + - name: Run PHPStan + # If STEP_DEBUG is enabled, PHPStan will run in debug mode. + run: | + if [ "${{ secrets.ACTIONS_STEP_DEBUG }}" = "true" ]; then + php vendor/bin/phpstan analyse --memory-limit=2G --debug + else + composer run-script phpstan + fi \ No newline at end of file diff --git a/.github/workflows/deploy-to-wordpress.org.yml b/.github/workflows/deploy-to-wordpress.org.yml new file mode 100644 index 0000000..8dcee29 --- /dev/null +++ b/.github/workflows/deploy-to-wordpress.org.yml @@ -0,0 +1,19 @@ +name: Deploy to WordPress.org +on: + push: + tags: + - "*" + +jobs: + tag: + name: New tag + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - name: WordPress Plugin Deploy + uses: 10up/action-wordpress-plugin-deploy@2.1.1 + env: + SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} + SVN_USERNAME: ${{ secrets.SVN_USERNAME }} + SLUG: wpgraphql-ide + diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml index c2eb12a..561f3bb 100644 --- a/.github/workflows/e2e-tests.yml +++ b/.github/workflows/e2e-tests.yml @@ -1,32 +1,41 @@ name: E2E Tests on: - push: - branches: - - main - pull_request: - branches: - - main + push: + branches: + - main + pull_request: + branches: + - main jobs: - e2e-tests: - name: E2E tests on Node ${{ matrix.node-version }} - runs-on: ubuntu-latest - strategy: - matrix: - node-version: ['20'] - steps: - - name: Checkout code - uses: actions/checkout@v4 + e2e-tests: + name: E2E tests on Node ${{ matrix.node-version }} + runs-on: ubuntu-latest + strategy: + matrix: + node-version: ['20'] + steps: + - name: Checkout code + uses: actions/checkout@v4 - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version: ${{ matrix.node-version }} - cache: npm + - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: ${{ matrix.node-version }} + cache: npm - - name: Install dependencies - run: npm ci + - name: Cache Playwright Browsers + uses: actions/cache@v3 + with: + path: | + ~/.cache/ms-playwright/ + key: ${{ runner.os }}-playwright-${{ hashFiles('**/package-lock.json') }} + restore-keys: | + ${{ runner.os }}-playwright- - - name: Start WordPress & Run E2E tests - run: npm run test:e2e + - name: Install dependencies + run: npm ci + + - name: Start WordPress & Run E2E tests + run: npm run test:e2e \ No newline at end of file diff --git a/.wordpress-org/banner-1544x500.png b/.wordpress-org/banner-1544x500.png new file mode 100644 index 0000000..f6f39cf Binary files /dev/null and b/.wordpress-org/banner-1544x500.png differ diff --git a/.wordpress-org/banner-772x250.png b/.wordpress-org/banner-772x250.png new file mode 100644 index 0000000..f0337b6 Binary files /dev/null and b/.wordpress-org/banner-772x250.png differ diff --git a/.wordpress-org/icon-128x128.png b/.wordpress-org/icon-128x128.png new file mode 100644 index 0000000..b31f9a6 Binary files /dev/null and b/.wordpress-org/icon-128x128.png differ diff --git a/.wordpress-org/icon-256x256.png b/.wordpress-org/icon-256x256.png new file mode 100644 index 0000000..9f50528 Binary files /dev/null and b/.wordpress-org/icon-256x256.png differ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/bin/version-plugin.js b/bin/version-plugin.js index cdb8816..754ad14 100755 --- a/bin/version-plugin.js +++ b/bin/version-plugin.js @@ -43,7 +43,7 @@ async function versionPlugin() { async function bumpPluginHeader( pluginFile, version ) { return bumpVersion( pluginFile, - /^\s*\*\s*Version:\s*([0-9.]+)$/gm, + /^\s*\*\s*Version:\s*([0-9.]+)\s*$/gm, version ); } @@ -60,7 +60,7 @@ async function bumpStableTag( readmeTxt, version ) { } /** - * Updates the version constant found in the WPGraphQLContentBlocks.php file. + * Updates the version constant found in the wpgraphql-ide.php file. * * @param {string} pluginFile Full path to a file containing PHP constants. * @param {string} version The new version number. @@ -68,7 +68,7 @@ async function bumpStableTag( readmeTxt, version ) { async function bumpVersionConstant( pluginFile, version ) { return bumpVersion( pluginFile, - /^\s*define\(\s*'WPGRAPHQL_IDE_VERSION',\s*'([0-9.]+)'\s*\);/, + /^\s*define\(\s*'WPGRAPHQL_IDE_VERSION',\s*'([0-9.]+)'\s*\);/gm, version ); } @@ -115,7 +115,7 @@ async function bumpVersion( file, regex, version ) { * * @param {string} pluginPath Full path to the directory containing the plugin's * package.json file. - * @return The version number string found in the plugin's package.json. + * @return {string|undefined} The version number string found in the plugin's package.json. */ async function getNewVersion( pluginPath ) { const packageJsonFile = path.join( pluginPath, 'package.json' ); diff --git a/composer.json b/composer.json index 5c9756e..e00413b 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,10 @@ "automattic/vipwpcs": "^3.0", "slevomat/coding-standard": "^8.9", "phpcompatibility/phpcompatibility-wp": "^2.1", - "phpcompatibility/php-compatibility": "dev-develop as 9.9.9" + "phpcompatibility/php-compatibility": "dev-develop as 9.9.9", + "phpstan/phpstan": "^1.11", + "phpstan/extension-installer": "^1.4", + "szepeviktor/phpstan-wordpress": "^1.3" }, "scripts": { "phpcs-i": [ @@ -28,11 +31,15 @@ ], "fix-cs": [ "php ./vendor/bin/phpcbf" + ], + "phpstan": [ + "phpstan analyze --ansi --memory-limit=2G" ] }, "config": { "allow-plugins": { - "dealerdirect/phpcodesniffer-composer-installer": true + "dealerdirect/phpcodesniffer-composer-installer": true, + "phpstan/extension-installer": true } } } diff --git a/composer.lock b/composer.lock index f0746fe..ac68cb4 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "b02980443416834f4ee65874f4fd3321", + "content-hash": "d0cf7b319f98ec2214f382d582fa0f85", "packages": [], "packages-dev": [ { @@ -139,6 +139,53 @@ }, "time": "2023-01-05T11:28:13+00:00" }, + { + "name": "php-stubs/wordpress-stubs", + "version": "v6.5.3", + "source": { + "type": "git", + "url": "https://github.com/php-stubs/wordpress-stubs.git", + "reference": "e611a83292d02055a25f83291a98fadd0c21e092" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-stubs/wordpress-stubs/zipball/e611a83292d02055a25f83291a98fadd0c21e092", + "reference": "e611a83292d02055a25f83291a98fadd0c21e092", + "shasum": "" + }, + "require-dev": { + "dealerdirect/phpcodesniffer-composer-installer": "^1.0", + "nikic/php-parser": "^4.13", + "php": "^7.4 || ~8.0.0", + "php-stubs/generator": "^0.8.3", + "phpdocumentor/reflection-docblock": "5.3", + "phpstan/phpstan": "^1.10.49", + "phpunit/phpunit": "^9.5", + "szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset": "^0.11" + }, + "suggest": { + "paragonie/sodium_compat": "Pure PHP implementation of libsodium", + "symfony/polyfill-php80": "Symfony polyfill backporting some PHP 8.0+ features to lower PHP versions", + "szepeviktor/phpstan-wordpress": "WordPress extensions for PHPStan" + }, + "type": "library", + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "WordPress function and class declaration stubs for static analysis.", + "homepage": "https://github.com/php-stubs/wordpress-stubs", + "keywords": [ + "PHPStan", + "static analysis", + "wordpress" + ], + "support": { + "issues": "https://github.com/php-stubs/wordpress-stubs/issues", + "source": "https://github.com/php-stubs/wordpress-stubs/tree/v6.5.3" + }, + "time": "2024-05-08T02:12:31+00:00" + }, { "name": "phpcompatibility/php-compatibility", "version": "dev-develop", @@ -507,6 +554,50 @@ ], "time": "2023-12-08T14:50:00+00:00" }, + { + "name": "phpstan/extension-installer", + "version": "1.4.1", + "source": { + "type": "git", + "url": "https://github.com/phpstan/extension-installer.git", + "reference": "f6b87faf9fc7978eab2f7919a8760bc9f58f9203" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpstan/extension-installer/zipball/f6b87faf9fc7978eab2f7919a8760bc9f58f9203", + "reference": "f6b87faf9fc7978eab2f7919a8760bc9f58f9203", + "shasum": "" + }, + "require": { + "composer-plugin-api": "^2.0", + "php": "^7.2 || ^8.0", + "phpstan/phpstan": "^1.9.0" + }, + "require-dev": { + "composer/composer": "^2.0", + "php-parallel-lint/php-parallel-lint": "^1.2.0", + "phpstan/phpstan-strict-rules": "^0.11 || ^0.12 || ^1.0" + }, + "type": "composer-plugin", + "extra": { + "class": "PHPStan\\ExtensionInstaller\\Plugin" + }, + "autoload": { + "psr-4": { + "PHPStan\\ExtensionInstaller\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "Composer plugin for automatic installation of PHPStan extensions", + "support": { + "issues": "https://github.com/phpstan/extension-installer/issues", + "source": "https://github.com/phpstan/extension-installer/tree/1.4.1" + }, + "time": "2024-06-10T08:20:49+00:00" + }, { "name": "phpstan/phpdoc-parser", "version": "1.26.0", @@ -554,6 +645,64 @@ }, "time": "2024-02-23T16:05:55+00:00" }, + { + "name": "phpstan/phpstan", + "version": "1.11.5", + "source": { + "type": "git", + "url": "https://github.com/phpstan/phpstan.git", + "reference": "490f0ae1c92b082f154681d7849aee776a7c1443" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpstan/phpstan/zipball/490f0ae1c92b082f154681d7849aee776a7c1443", + "reference": "490f0ae1c92b082f154681d7849aee776a7c1443", + "shasum": "" + }, + "require": { + "php": "^7.2|^8.0" + }, + "conflict": { + "phpstan/phpstan-shim": "*" + }, + "bin": [ + "phpstan", + "phpstan.phar" + ], + "type": "library", + "autoload": { + "files": [ + "bootstrap.php" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "PHPStan - PHP Static Analysis Tool", + "keywords": [ + "dev", + "static analysis" + ], + "support": { + "docs": "https://phpstan.org/user-guide/getting-started", + "forum": "https://github.com/phpstan/phpstan/discussions", + "issues": "https://github.com/phpstan/phpstan/issues", + "security": "https://github.com/phpstan/phpstan/security/policy", + "source": "https://github.com/phpstan/phpstan-src" + }, + "funding": [ + { + "url": "https://github.com/ondrejmirtes", + "type": "github" + }, + { + "url": "https://github.com/phpstan", + "type": "github" + } + ], + "time": "2024-06-17T15:10:54+00:00" + }, { "name": "sirbrillig/phpcs-variable-analysis", "version": "v2.11.17", @@ -757,6 +906,144 @@ ], "time": "2024-02-16T15:06:51+00:00" }, + { + "name": "symfony/polyfill-php73", + "version": "v1.29.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-php73.git", + "reference": "21bd091060673a1177ae842c0ef8fe30893114d2" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-php73/zipball/21bd091060673a1177ae842c0ef8fe30893114d2", + "reference": "21bd091060673a1177ae842c0ef8fe30893114d2", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "type": "library", + "extra": { + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/symfony/polyfill" + } + }, + "autoload": { + "files": [ + "bootstrap.php" + ], + "psr-4": { + "Symfony\\Polyfill\\Php73\\": "" + }, + "classmap": [ + "Resources/stubs" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "polyfill", + "portable", + "shim" + ], + "support": { + "source": "https://github.com/symfony/polyfill-php73/tree/v1.29.0" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2024-01-29T20:11:03+00:00" + }, + { + "name": "szepeviktor/phpstan-wordpress", + "version": "v1.3.4", + "source": { + "type": "git", + "url": "https://github.com/szepeviktor/phpstan-wordpress.git", + "reference": "891d0767855a32c886a439efae090408cc1fa156" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/szepeviktor/phpstan-wordpress/zipball/891d0767855a32c886a439efae090408cc1fa156", + "reference": "891d0767855a32c886a439efae090408cc1fa156", + "shasum": "" + }, + "require": { + "php": "^7.2 || ^8.0", + "php-stubs/wordpress-stubs": "^4.7 || ^5.0 || ^6.0", + "phpstan/phpstan": "^1.10.31", + "symfony/polyfill-php73": "^1.12.0" + }, + "require-dev": { + "composer/composer": "^2.1.14", + "dealerdirect/phpcodesniffer-composer-installer": "^1.0", + "php-parallel-lint/php-parallel-lint": "^1.1", + "phpstan/phpstan-strict-rules": "^1.2", + "phpunit/phpunit": "^8.0 || ^9.0", + "szepeviktor/phpcs-psr-12-neutron-hybrid-ruleset": "^0.8" + }, + "suggest": { + "swissspidy/phpstan-no-private": "Detect usage of internal core functions, classes and methods" + }, + "type": "phpstan-extension", + "extra": { + "phpstan": { + "includes": [ + "extension.neon" + ] + } + }, + "autoload": { + "psr-4": { + "SzepeViktor\\PHPStan\\WordPress\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "description": "WordPress extensions for PHPStan", + "keywords": [ + "PHPStan", + "code analyse", + "code analysis", + "static analysis", + "wordpress" + ], + "support": { + "issues": "https://github.com/szepeviktor/phpstan-wordpress/issues", + "source": "https://github.com/szepeviktor/phpstan-wordpress/tree/v1.3.4" + }, + "time": "2024-03-21T16:32:59+00:00" + }, { "name": "wp-coding-standards/wpcs", "version": "3.0.1", @@ -842,5 +1129,5 @@ "php": "^8.0" }, "platform-dev": [], - "plugin-api-version": "2.3.0" + "plugin-api-version": "2.6.0" } diff --git a/phpcs.xml.dist b/phpcs.xml.dist index cc8cc75..708dcf4 100644 --- a/phpcs.xml.dist +++ b/phpcs.xml.dist @@ -91,6 +91,14 @@ + + + + + + + + diff --git a/phpstan.neon.dist b/phpstan.neon.dist new file mode 100644 index 0000000..01fd5e6 --- /dev/null +++ b/phpstan.neon.dist @@ -0,0 +1,28 @@ +parameters: + level: 8 + dynamicConstantNames: + - WPGRAPHQL_AUTOLOAD + treatPhpDocTypesAsCertain: false + inferPrivatePropertyTypeFromConstructor: true + checkAlwaysTrueCheckTypeFunctionCall: true + checkAlwaysTrueInstanceof: true + checkAlwaysTrueStrictComparison: true + checkExplicitMixedMissingReturn: true + checkFunctionNameCase: true + checkInternalClassCaseSensitivity: true + checkMissingIterableValueType: true + checkTooWideReturnTypesInProtectedAndPublicMethods: true + polluteScopeWithAlwaysIterableForeach: false + polluteScopeWithLoopInitialAssignments: false + reportAlwaysTrueInLastCondition: true + reportStaticMethodSignatures: true + reportWrongPhpDocTypeInVarTag: true + bootstrapFiles: + - wpgraphql-ide.php + paths: + - wpgraphql-ide.php + excludePaths: + analyseAndScan: + - */node_modules/* + - */vendor/* + ignoreErrors: \ No newline at end of file diff --git a/wpgraphql-ide.php b/wpgraphql-ide.php index 82f2d7d..33beda8 100644 --- a/wpgraphql-ide.php +++ b/wpgraphql-ide.php @@ -10,6 +10,7 @@ * Version: 2.1.2 * Requires PHP: 7.4 * Tested up to: 6.5 + * Requires Plugins: wp-graphql * * @package WPGraphQLIDE */ @@ -20,67 +21,158 @@ exit; } -define( 'WPGRAPHQL_IDE_VERSION', '2.0.0' ); +define( 'WPGRAPHQL_IDE_VERSION', '2.1.2' ); define( 'WPGRAPHQL_IDE_ROOT_ELEMENT_ID', 'wpgraphql-ide-root' ); define( 'WPGRAPHQL_IDE_PLUGIN_DIR_PATH', plugin_dir_path( __FILE__ ) ); define( 'WPGRAPHQL_IDE_PLUGIN_URL', plugin_dir_url( __FILE__ ) ); /** - * Register core IDE plugins. + * Check if WPGraphQL is available and handle the case where it is not. + * + * @return void */ -require_once WPGRAPHQL_IDE_PLUGIN_DIR_PATH . 'plugins/query-composer-panel/query-composer-panel.php'; -require_once WPGRAPHQL_IDE_PLUGIN_DIR_PATH . 'plugins/help-panel/help-panel.php'; +function check_wpgraphql_availability() { + if ( ! class_exists( 'WPGraphQL' ) ) { + add_action( 'admin_notices', __NAMESPACE__ . '\\show_admin_notice' ); + } else { + add_custom_capabilities(); + + do_action( 'wpgraphql_ide_init' ); + } +} +add_action( 'init', __NAMESPACE__ . '\\check_wpgraphql_availability' ); /** - * Generates the SVG logo for GraphQL. + * Initialize the plugin. * - * @return string The SVG logo markup. + * @return void */ -function graphql_logo_svg(): string { - return << - - - - - - - - - - - - - - - - - - - - - -XML; +function initialize_plugin() { + add_action( 'admin_menu', __NAMESPACE__ . '\\register_dedicated_ide_menu' ); + add_action( 'admin_bar_menu', __NAMESPACE__ . '\\register_wpadminbar_menus', 999 ); + add_action( 'admin_enqueue_scripts', __NAMESPACE__ . '\\enqueue_graphql_ide_menu_icon_css' ); + add_action( 'wp_enqueue_scripts', __NAMESPACE__ . '\\enqueue_graphql_ide_menu_icon_css' ); + add_action( 'admin_enqueue_scripts', __NAMESPACE__ . '\\enqueue_react_app_with_styles' ); + add_action( 'wp_enqueue_scripts', __NAMESPACE__ . '\\enqueue_react_app_with_styles' ); + + add_action( 'graphql_register_settings', __NAMESPACE__ . '\\register_ide_settings' ); + add_action( 'graphql_admin_notices_render_notices', __NAMESPACE__ . '\\graphql_admin_notices_render_notices', 10, 1 ); + add_action( 'graphql_admin_notices_render_notice', __NAMESPACE__ . '\\graphql_admin_notices_render_notice', 10, 4 ); + + add_filter( 'graphql_admin_notices_is_allowed_admin_page', __NAMESPACE__ . '\\graphql_admin_notices_is_allowed_admin_page', 10, 3 ); + add_filter( 'script_loader_tag', __NAMESPACE__ . '\\add_defer_attribute_to_script', 10, 2 ); + add_filter( 'graphql_setting_field_config', __NAMESPACE__ . '\\update_graphiql_link_field_config', 10, 3 ); + add_filter( 'graphql_get_setting_section_field_value', __NAMESPACE__ . '\\ensure_graphiql_link_is_unchecked', 10, 5 ); + add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), __NAMESPACE__ . '\\add_settings_link' ); + + // Core plugins/modules. + require_once WPGRAPHQL_IDE_PLUGIN_DIR_PATH . 'plugins/query-composer-panel/query-composer-panel.php'; + require_once WPGRAPHQL_IDE_PLUGIN_DIR_PATH . 'plugins/help-panel/help-panel.php'; +} +add_action( 'wpgraphql_ide_init', __NAMESPACE__ . '\\initialize_plugin' ); + +/** + * Show admin notice if WPGraphQL is not available. + * + * @return void + */ +function show_admin_notice() { + ?> +
+

+
    +
    2. +
+
+ The array of custom capabilities and roles. */ -function user_lacks_capability(): bool { - $capability_required = apply_filters( 'wpgraphqlide_capability_required', 'manage_options' ); +function get_custom_capabilities() { + return [ + 'manage_graphql_ide' => [ 'administrator' ], + ]; +} - return ! current_user_can( $capability_required ); +/** + * Generate a hash for the capabilities array. + * + * @param array $capabilities Array of capabilities and roles. + * @return string MD5 hash of the capabilities array. + */ +function generate_capabilities_hash( $capabilities ) { + return md5( (string) wp_json_encode( $capabilities ) ); } /** - * Determines if the current admin page is a dedicated WPGraphQL IDE page. + * Check if the capabilities hash has changed. + * + * @param string $current_hash Current hash of the capabilities array. + * @return bool True if the hash has changed, false otherwise. + */ +function has_capabilities_hash_changed( $current_hash ) { + $stored_hash = get_option( 'wpgraphql_ide_capabilities' ); + return $current_hash !== $stored_hash; +} + +/** + * Update the capabilities for the specified roles. + * + * @param array $capabilities Array of capabilities and roles. + */ +function update_roles_capabilities( $capabilities ): void { + foreach ( $capabilities as $capability => $roles ) { + foreach ( $roles as $role_name ) { + $role = get_role( $role_name ); + + if ( $role && ! $role->has_cap( $capability ) ) { + $role->add_cap( $capability ); + } + } + } +} + +/** + * Save the new capabilities hash in the options table. + * + * @param string $current_hash Current hash of the capabilities array. + */ +function save_capabilities_hash( $current_hash ): void { + update_option( 'wpgraphql_ide_capabilities', $current_hash ); +} + +/** + * Adds custom capabilities to specified roles. + */ +function add_custom_capabilities(): void { + $capabilities = get_custom_capabilities(); + $current_hash = generate_capabilities_hash( $capabilities ); + + if ( ! has_capabilities_hash_changed( $current_hash ) ) { + return; + } + + update_roles_capabilities( $capabilities ); + save_capabilities_hash( $current_hash ); +} + +/** + * Checks if the current user has the capability required to load scripts and styles for the GraphQL IDE. * - * This function checks whether the current admin page is exclusively for either the new GraphQL IDE - * or the legacy GraphiQL IDE, distinguishing them from other admin pages where the IDE might be present - * in a drawer. It is designed to help in tailoring the admin interface or enqueuing specific scripts - * and styles on these dedicated IDE pages. + * @return bool Whether the user has the required capability. + */ +function user_has_graphql_ide_capability(): bool { + $capability_required = apply_filters( 'wpgraphqlide_capability_required', 'manage_graphql_ide' ); + + return current_user_can( $capability_required ); +} + +/** + * Determines if the current admin page is a dedicated WPGraphQL IDE page. * * @return bool True if the current page is a dedicated WPGraphQL IDE page, false otherwise. */ @@ -99,7 +191,7 @@ function is_ide_page(): bool { } $screen = get_current_screen(); - if ( ! $screen ) { + if ( ! ( $screen instanceof \WP_Screen ) ) { return false; } @@ -117,7 +209,7 @@ function is_legacy_ide_page(): bool { } $screen = get_current_screen(); - if ( ! $screen ) { + if ( ! ( $screen instanceof \WP_Screen ) ) { return false; } @@ -130,7 +222,7 @@ function is_legacy_ide_page(): bool { * @global WP_Admin_Bar $wp_admin_bar The WordPress Admin Bar instance. */ function register_wpadminbar_menus(): void { - if ( user_lacks_capability() ) { + if ( ! user_has_graphql_ide_capability() ) { return; } @@ -164,22 +256,15 @@ function register_wpadminbar_menus(): void { ); } } -add_action( 'admin_bar_menu', __NAMESPACE__ . '\\register_wpadminbar_menus', 999 ); /** * Registers a submenu page for the dedicated GraphQL IDE. * - * This function checks if the current user has the necessary capabilities - * to access the GraphQL IDE. If the user has the required capabilities, - * it adds a submenu page under a specified parent menu. The submenu page - * is intended to provide access to a dedicated GraphQL IDE within the WordPress - * admin area. - * * @see add_submenu_page() For more information on adding submenu pages. * @link https://developer.wordpress.org/reference/functions/add_submenu_page/ */ function register_dedicated_ide_menu(): void { - if ( user_lacks_capability() ) { + if ( ! user_has_graphql_ide_capability() ) { return; } @@ -195,12 +280,11 @@ function register_dedicated_ide_menu(): void { 'graphiql-ide', __( 'GraphQL IDE', 'wpgraphql-ide' ), __( 'GraphQL IDE', 'wpgraphql-ide' ), - 'manage_options', + 'manage_graphql_ide', 'graphql-ide', __NAMESPACE__ . '\\render_dedicated_ide_page' ); } -add_action( 'admin_menu', __NAMESPACE__ . '\\register_dedicated_ide_menu' ); /** * Renders the container for the dedicated IDE page for the React app to be mounted to. @@ -213,28 +297,26 @@ function render_dedicated_ide_page(): void { * Enqueues custom CSS to set the "GraphQL IDE" menu item icon in the WordPress Admin Bar. */ function enqueue_graphql_ide_menu_icon_css(): void { - if ( user_lacks_capability() ) { + if ( ! user_has_graphql_ide_capability() ) { return; } $custom_css = ' - #wp-admin-bar-wpgraphql-ide .ab-icon::before, - #wp-admin-bar-wpgraphql-ide .ab-icon::before { - background-image: url("data:image/svg+xml;base64,' . base64_encode( graphql_logo_svg() ) . '"); - background-size: 100%; - border-radius: 12px; - box-sizing: border-box; - content: ""; - display: inline-block; - height: 24px; - width: 24px; - } - '; + #wp-admin-bar-wpgraphql-ide .ab-icon::before, + #wp-admin-bar-wpgraphql-ide .ab-icon::before { + background-image: url("data:image/svg+xml;base64,' . base64_encode( graphql_logo_svg() ) . '"); + background-size: 100%; + border-radius: 12px; + box-sizing: border-box; + content: ""; + display: inline-block; + height: 24px; + width: 24px; + } + '; wp_add_inline_style( 'admin-bar', $custom_css ); } -add_action( 'admin_enqueue_scripts', __NAMESPACE__ . '\\enqueue_graphql_ide_menu_icon_css' ); -add_action( 'wp_enqueue_scripts', __NAMESPACE__ . '\\enqueue_graphql_ide_menu_icon_css' ); /** * Enqueues the React application script and associated styles. @@ -248,14 +330,15 @@ function enqueue_react_app_with_styles(): void { return; } - if ( user_lacks_capability() ) { + if ( ! user_has_graphql_ide_capability() ) { return; } // Don't enqueue new styles/scripts on the legacy IDE page if ( function_exists( 'get_current_screen' ) ) { $screen = get_current_screen(); - if ( 'toplevel_page_graphiql-ide' === $screen->id ) { + + if ( $screen instanceof \WP_Screen && 'toplevel_page_graphiql-ide' === $screen->id ) { return; } } @@ -315,8 +398,6 @@ function enqueue_react_app_with_styles(): void { // Avoid running custom styles through a build process for an improved developer experience. wp_enqueue_style( 'wpgraphql-ide', plugins_url( 'styles/wpgraphql-ide.css', __FILE__ ), [], $asset_file['version'] ); } -add_action( 'admin_enqueue_scripts', __NAMESPACE__ . '\\enqueue_react_app_with_styles' ); -add_action( 'wp_enqueue_scripts', __NAMESPACE__ . '\\enqueue_react_app_with_styles' ); /** * Retrieves the base URL for the dedicated WPGraphQL IDE page. @@ -331,7 +412,7 @@ function get_dedicated_ide_base_url(): string { * Retrieves the specific header of this plugin. * * @param string $key The plugin data key. - * @return string|null The version number of the plugin. Returns an empty string if the version is not found. + * @return string|null The version number of the plugin. Returns null if the version is not found. */ function get_plugin_header( string $key = '' ): ?string { if ( ! function_exists( 'get_plugin_data' ) ) { @@ -344,13 +425,19 @@ function get_plugin_header( string $key = '' ): ?string { $plugin_data = get_plugin_data( __FILE__ ); - return $plugin_data[ $key ] ?? null; + if ( ! is_array( $plugin_data ) ) { + return null; + } + + $plugin_header = $plugin_data[ $key ] ?? null; + + return is_string( $plugin_header ) ? $plugin_header : null; } /** * Retrieves app context. * - * @return array The possibly filtered app context array. + * @return array The possibly filtered app context array. */ function get_app_context(): array { $current_user = wp_get_current_user(); @@ -371,117 +458,87 @@ function get_app_context(): array { } /** - * Add styles to hide generic admin notices on the graphiql-ide page - * and play nice with notices added via register_graphql_admin_notice + * Adds styles to hide generic admin notices on the GraphQL IDE page. * - * @param array $notices The array of notices to render - */ -add_action( - 'graphql_admin_notices_render_notices', - static function ( array $notices ) { - - echo ' - - '; - }, - 10, - 1 -); + * @param array $notices The array of notices to render. + */ +function graphql_admin_notices_render_notices( array $notices ): void { + echo ' + + '; +} /** - * Add styles to apply top margin to notices added via register_graphql_admin_notice + * Adds styles to apply top margin to notices added via register_graphql_admin_notice. * - * @param string $notice_slug The slug of the notice - * @param array $notice The notice data - * @param bool $is_dismissable Whether the notice is dismissable - * @param int $count The count of notices - */ -add_action( - 'graphql_admin_notices_render_notice', - static function ( string $notice_slug, array $notice, bool $is_dismissable, int $count ) { - - echo ' - - '; - }, - 10, - 4 -); + * @param string $notice_slug The slug of the notice. + * @param array $notice The notice data. + * @param bool $is_dismissable Whether the notice is dismissable. + * @param int $count The count of notices. + */ +function graphql_admin_notices_render_notice( string $notice_slug, array $notice, bool $is_dismissable, int $count ): void { + echo ' + + '; +} /** - * Filter to allow graphql admin notices to be displayed on the dedicated IDE page. + * Filters to allow GraphQL admin notices to be displayed on the dedicated IDE page. * - * @param bool $is_plugin_scoped_page True if the current page is within scope of the plugin's pages. - * @param string $current_page_id The ID of the current admin page. - * @param array $allowed_pages The list of allowed pages. + * @param bool $is_plugin_scoped_page True if the current page is within scope of the plugin's pages. + * @param string $current_page_id The ID of the current admin page. + * @param array $allowed_pages The list of allowed pages. + * @return bool Whether the admin notice is allowed on the current page. */ -add_filter( - 'graphql_admin_notices_is_allowed_admin_page', - static function ( bool $is_plugin_scoped_page, string $current_page_id, array $allowed_pages ) { - - // If the current page is the dedicated IDE page, we want to allow notices to be displayed. - if ( 'graphql_page_graphql-ide' === $current_page_id ) { - return true; - } +function graphql_admin_notices_is_allowed_admin_page( bool $is_plugin_scoped_page, string $current_page_id, array $allowed_pages ): bool { + // If the current page is the dedicated IDE page, we want to allow notices to be displayed. + if ( 'graphql_page_graphql-ide' === $current_page_id ) { + return true; + } - return $is_plugin_scoped_page; - }, - 10, - 3 -); + return $is_plugin_scoped_page; +} /** * Modifies the script tag for specific scripts to add the 'defer' attribute. * - * This function checks if the script handle matches 'wpgraphql-ide' and, if so, - * adds the 'defer' attribute to the script tag. This allows the script to be executed - * after the HTML document is parsed but before the DOMContentLoaded event. - * - * @param string $tag The HTML `