diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index c8aebcf651..2a1338f9b9 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -94,6 +94,7 @@ /packages/eth-json-rpc-middleware @MetaMask/core-platform /packages/messenger @MetaMask/core-platform /packages/messenger-cli @MetaMask/core-platform +/packages/platform-api-docs @MetaMask/core-platform /packages/sample-controllers @MetaMask/core-platform /packages/polling-controller @MetaMask/core-platform /packages/preferences-controller @MetaMask/core-platform diff --git a/.github/workflows/deploy-platform-api-docs.yml b/.github/workflows/deploy-platform-api-docs.yml new file mode 100644 index 0000000000..e642003492 --- /dev/null +++ b/.github/workflows/deploy-platform-api-docs.yml @@ -0,0 +1,75 @@ +name: Deploy Platform API Docs + +on: + push: + branches: [main] + pull_request: + branches: [main] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + build-docs: + name: Build Platform API docs + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - name: Checkout and setup environment + uses: MetaMask/action-checkout-and-setup@v3 + with: + is-high-risk-environment: true + + - name: Generate and build Platform API docs + # The site is published under the `/platform-api/` subdirectory of + # the repo's GitHub Pages site so that other doc sites (e.g. + # package API docs) can be hosted alongside under sibling paths. + run: | + yarn docs:platform-api:build \ + --site-url "https://${{ github.repository_owner }}.github.io" \ + --site-base-url "/${{ github.event.repository.name }}/platform-api/" + + - name: Upload build artifact (PR) + if: github.event_name == 'pull_request' + uses: actions/upload-artifact@v7 + with: + name: platform-api-docs + path: .platform-api-docs/build/ + retention-days: 7 + + - name: Upload build artifact for deploy job + if: github.ref == 'refs/heads/main' && github.event_name == 'push' + uses: actions/upload-artifact@v7 + with: + name: platform-api-docs-build + path: .platform-api-docs/build/ + retention-days: 1 + + deploy: + name: Deploy to GitHub Pages + if: github.ref == 'refs/heads/main' && github.event_name == 'push' + needs: build-docs + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Download build artifact + uses: actions/download-artifact@v8 + with: + name: platform-api-docs-build + path: build/ + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4.1.0 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./build + destination_dir: platform-api + # Preserve sibling subdirectories (e.g. /package-api/) so this + # deploy only overwrites /platform-api/. + keep_files: true diff --git a/.gitignore b/.gitignore index 2f1de08239..448611d4ac 100644 --- a/.gitignore +++ b/.gitignore @@ -37,4 +37,7 @@ scripts/coverage packages/*/*.tsbuildinfo # AI -.sisyphus/ \ No newline at end of file +.sisyphus/ + +# Platform API docs (generated) +.platform-api-docs/ diff --git a/README.md b/README.md index 64a2300566..dab593c0bc 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,7 @@ Each package in this repository has its own README where you can find installati - [`@metamask/permission-log-controller`](packages/permission-log-controller) - [`@metamask/perps-controller`](packages/perps-controller) - [`@metamask/phishing-controller`](packages/phishing-controller) +- [`@metamask/platform-api-docs`](packages/platform-api-docs) - [`@metamask/polling-controller`](packages/polling-controller) - [`@metamask/preferences-controller`](packages/preferences-controller) - [`@metamask/profile-metrics-controller`](packages/profile-metrics-controller) @@ -176,6 +177,7 @@ linkStyle default opacity:0.5 permission_log_controller(["@metamask/permission-log-controller"]); perps_controller(["@metamask/perps-controller"]); phishing_controller(["@metamask/phishing-controller"]); + platform_api_docs(["@metamask/platform-api-docs"]); polling_controller(["@metamask/polling-controller"]); preferences_controller(["@metamask/preferences-controller"]); profile_metrics_controller(["@metamask/profile-metrics-controller"]); diff --git a/eslint.config.mjs b/eslint.config.mjs index 85f596606b..cbd30d01d5 100644 --- a/eslint.config.mjs +++ b/eslint.config.mjs @@ -76,9 +76,11 @@ const config = createConfig([ '**/dist/**', '**/docs/**', '**/coverage/**', + '.platform-api-docs/**', 'merged-packages/**', '.yarn/**', 'scripts/create-package/package-template/**', + 'packages/platform-api-docs/site/**', ], }, { @@ -114,6 +116,7 @@ const config = createConfig([ '**/tests/**/*.{js,ts}', 'scripts/*.ts', 'scripts/create-package/**/*.ts', + 'packages/platform-api-docs/**/*.ts', ], extends: [nodejs], }, @@ -207,7 +210,7 @@ const config = createConfig([ }, }, { - files: ['scripts/*.ts'], + files: ['scripts/*.ts', 'packages/platform-api-docs/src/cli.ts'], rules: { // Scripts may be self-executable and thus have hashbangs. 'n/hashbang': 'off', @@ -306,6 +309,14 @@ const config = createConfig([ 'import-x/no-nodejs-modules': 'off', }, }, + { + files: ['packages/platform-api-docs/**/*.{js,ts}'], + rules: { + 'import-x/no-nodejs-modules': 'off', + 'n/no-process-env': 'off', + 'n/no-sync': 'off', + }, + }, { files: [ 'packages/notification-services-controller/src/NotificationServicesPushController/services/push/*-web.ts', diff --git a/package.json b/package.json index ba1c3be0d9..7dae0f3299 100644 --- a/package.json +++ b/package.json @@ -22,6 +22,9 @@ "changelog:validate": "yarn workspaces foreach --all --no-private --parallel --interlaced --verbose run changelog:validate", "create-release-branch": "create-release-branch --formatter oxfmt", "create-package": "tsx scripts/create-package", + "docs:platform-api:build": "yarn workspace @metamask/platform-api-docs cli ../.. --build --project-label Core", + "docs:platform-api:dev": "yarn workspace @metamask/platform-api-docs cli ../.. --dev --project-label Core", + "docs:platform-api:serve": "yarn workspace @metamask/platform-api-docs cli ../.. --serve --project-label Core", "lint": "yarn lint:eslint && echo && yarn lint:misc --check && yarn constraints && yarn lint:dependencies && yarn lint:teams && yarn messenger-action-types:check && yarn readme-content:check", "lint:dependencies": "depcheck && yarn dedupe --check", "lint:dependencies:fix": "depcheck && yarn dedupe", @@ -96,7 +99,12 @@ }, "resolutions": { "elliptic@6.5.4": "^6.5.7", + "eslint-import-resolver-typescript": "3.7.0", + "eslint-plugin-import-x": "4.6.1", + "eslint-plugin-n": "17.15.1", "fast-xml-parser@^4.3.4": "^4.4.1", + "prettier@npm:^3.3.3": "3.4.2", + "webpackbar@^6.0.1": "^7.0.0", "ws@7.4.6": "^7.5.10" }, "simple-git-hooks": { @@ -111,9 +119,10 @@ "@lavamoat/preinstall-always-fail": false, "@keystonehq/bc-ur-registry-eth>hdkey>secp256k1": true, "babel-runtime>core-js": false, + "eslint-import-resolver-typescript>unrs-resolver": false, + "eslint-plugin-import-x>unrs-resolver": false, "simple-git-hooks": false, - "tsx>esbuild": false, - "eslint-plugin-import-x>unrs-resolver": false + "tsx>esbuild": false } } } diff --git a/packages/platform-api-docs/CHANGELOG.md b/packages/platform-api-docs/CHANGELOG.md new file mode 100644 index 0000000000..18d0182c35 --- /dev/null +++ b/packages/platform-api-docs/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- Initial release of the platform-api-docs package ([#8012](https://github.com/MetaMask/core/pull/8012)) + +[Unreleased]: https://github.com/MetaMask/core/ diff --git a/packages/platform-api-docs/LICENSE b/packages/platform-api-docs/LICENSE new file mode 100644 index 0000000000..8cb538233e --- /dev/null +++ b/packages/platform-api-docs/LICENSE @@ -0,0 +1,6 @@ +This project is licensed under either of + + * MIT license ([LICENSE.MIT](LICENSE.MIT)) + * Apache License, Version 2.0 ([LICENSE.APACHE2](LICENSE.APACHE2)) + +at your option. \ No newline at end of file diff --git a/packages/platform-api-docs/LICENSE.APACHE2 b/packages/platform-api-docs/LICENSE.APACHE2 new file mode 100644 index 0000000000..cd78052841 --- /dev/null +++ b/packages/platform-api-docs/LICENSE.APACHE2 @@ -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 2025 MetaMask + + 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. \ No newline at end of file diff --git a/packages/platform-api-docs/LICENSE.MIT b/packages/platform-api-docs/LICENSE.MIT new file mode 100644 index 0000000000..c259cd7ebc --- /dev/null +++ b/packages/platform-api-docs/LICENSE.MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 MetaMask + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/packages/platform-api-docs/README.md b/packages/platform-api-docs/README.md new file mode 100644 index 0000000000..cd97e88ff3 --- /dev/null +++ b/packages/platform-api-docs/README.md @@ -0,0 +1,39 @@ +# `@metamask/platform-api-docs` + +Produces documentation for the platform API, the set of actions and events available in clients through the message bus. + +When run within a project (such as `metamask-extension` or `metamask-mobile`), this tool looks for messenger action and event types declared within TypeScript source and declaration files within MetaMask NPM packages. It extracts all of the JSDoc from these actions and events, then outputs them into a searchable Docusaurus site. + +## Installation + +1. Add this package as a dependency (`yarn add --dev @metamask/platform-api-docs` or `npm install --save-dev @metamask/platform-api-docs`). +2. Add a script to your project's `package.json`. For example: + ```json + { + "scripts": { + "docs:platform-api:build": "platform-api-docs --build --project-label MyProject" + } + } + ``` + +## Usage + +``` +platform-api-docs [project-path] [options] + +Arguments: + project-path Path to the project to scan (default: current directory) + +Options: + --build Generate docs and build static site + --serve Generate docs, build, and serve static site + --dev Generate docs and start dev server with hot reload + --scan-dir Extra source directory to scan (repeatable) + --output Output directory (default: /.platform-api-docs) + --project-label