monkeypatchlist 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

package/NOTICE

@@ -0,0 +1,61 @@
+monkeypatchlist
+Copyright 2026 Adam Medford
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+
+Catalog data sources
+--------------------
+
+monkeypatchlist's runtime catalog (catalog/catalog.json) is generated from the
+upstream packages below, at the exact versions recorded in the catalog's
+metadata.upstream, together with curated overlays that are part of monkeypatchlist.
+The catalog records the names, owners and shapes of web platform and
+ECMAScript APIs that these sources define.
+
+  @webref/idl (W3C webref)
+    https://github.com/w3c/webref
+    Web IDL extracted from the specifications of the web platform.
+    Package license: MIT.
+    The IDL comes from specifications published by the W3C, the WHATWG and
+    other groups, each under its own license. WHATWG Living Standards are
+    licensed under the Creative Commons Attribution 4.0 International License
+    (CC BY 4.0), copyright WHATWG (Apple, Google, Mozilla, Microsoft). W3C
+    specifications are copyright World Wide Web Consortium; code components
+    such as IDL are available under the W3C Software and Document License.
+
+  webidl2
+    https://github.com/w3c/webidl2.js
+    The Web IDL parser the generator reads @webref/idl with.
+    License: MIT (its LICENSE file; its package.json declares W3C, the W3C
+    Software and Document License). Copyright (c) 2014 Robin Berjon.
+
+  @tc39/ecma262-biblio and @tc39/ecma402-biblio
+    https://github.com/tc39/ecma262 and https://github.com/tc39/ecma402
+    The ECMA-262 (ECMAScript) and ECMA-402 (Internationalization API)
+    specification biblios, for the ECMAScript intrinsics.
+    Licensed under Ecma International TC39's Intellectual Property Policy:
+    natural language text under the alternative copyright notice of the Ecma
+    text copyright policy, and source code under the Ecma International Policy
+    on Submission, Inclusion and Licensing of Software. Copyright Ecma
+    International.
+
+The catalog generator also cross-checks the catalog against two sources that
+never change it, at exact-pinned versions:
+
+  ses (Endo) src/permits.js
+    https://github.com/endojs/endo
+    License: Apache-2.0. Copyright Endo Contributors.
+
+  @mdn/browser-compat-data
+    https://github.com/mdn/browser-compat-data
+    License: CC0-1.0. Data from MDN Web Docs and its contributors.
+
+
+Runtime dependencies
+--------------------
+
+monkeypatchlist's runtime dependencies are installed separately by the package
+manager, under their own licenses (MIT, BSD-2-Clause and BSD-3-Clause), and
+none of their code is bundled into this package. In the source repository,
+`npm run licenses:check` lists them.

package/README.md

@@ -1,3 +1,184 @@
-# Temporary Holding Version
+# monkeypatchlist
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+monkeypatchlist is a CI gate for the browser platform. It scans your deployed JavaScript statically, finds the code that changes native browser and ECMAScript APIs, says which package or source file that code came from, and tells you what changed since the baseline you last accepted:
+
+> What changed the browser platform, who introduced it, and is that change new?
+
+**Release 1 is an early release.** It models Chromium's behaviour, it is slow on large bundles (see [Performance](#performance)), and it has rough edges. Please [report what you find](https://github.com/adammedford/monkeypatchlist/issues).
+
+## Why
+
+Monitoring SDKs, polyfills, zone libraries and your own code all reach into the platform the rest of the page shares. They wrap `fetch`, replace `history.pushState`, patch `XMLHttpRequest.prototype.open` and add methods to `Array.prototype`. Each change is usually deliberate, but it is rarely reviewed. A dependency upgrade can start wrapping a new API without a line of your code changing, and when something breaks in production, nobody knows which bundled package hooks `fetch`.
+
+monkeypatchlist turns those changes into reviewed changes. You commit a baseline of the platform mutations your app makes today, and CI fails when a build adds a new one or changes an existing one. It names every mutation the same way on every build, so a rebuild, a renamed chunk or a new minifier never shows up as a change, and it reports what it couldn't analyze instead of passing silently.
+
+## Install
+
+```sh
+npm i -D monkeypatchlist
+```
+
+monkeypatchlist needs Node.js 24 or later. It runs offline by default and executes none of the code it scans.
+
+## Performance
+
+Release 1's analyzer is slow, and scan time grows faster than bundle size. On an Apple M4 Pro, the SDK and polyfill builds in the validation corpus each scan in seconds to a few minutes. A synthetic 1 MB bundle took about 6 minutes, and a 2.5 MB bundle took about 10 hours. Try it on your own build before you add it to CI. A faster analyzer is planned. [Limitations](docs/limitations.md) has the measured numbers.
+
+## Quickstart
+
+**1. Scan your build.** monkeypatchlist scans build output, not source. Point it at the directory you deploy, and tell it the URL that directory is served from with `--map`, so the references in your HTML resolve to files:
+
+```sh
+npx monkeypatchlist scan dist --map https://shop.example/=.
+```
+
+The report lists each platform mutation the build makes. Without source maps every finding's package is `unknown`, so the next step adds them.
+
+**2. Save your settings.** Put the mapping, your source-map directory and your lockfile in `monkeypatchlist.config.json`, so every command picks them up. Source maps name the package behind each finding, and the lockfile adds its version:
+
+<!-- docs-test: file monkeypatchlist.config.json -->
+```json
+{
+  "name": "Storefront",
+  "mappings": [{ "url": "https://shop.example/", "dir": "." }],
+  "sourceMaps": ["maps"],
+  "lockfile": { "path": "package-lock.json" }
+}
+```
+
+**3. Accept what's there today.** Write a baseline of the current findings, and commit it next to your code:
+
+```sh
+npx monkeypatchlist baseline init dist
+git add monkeypatchlist.config.json monkeypatchlist.baseline.json
+```
+
+**4. Gate CI.** Run the scan with `--fail-on added,changed` after your build. It passes while the build makes only the mutations the baseline accepted:
+
+```sh
+npx monkeypatchlist scan dist --fail-on added,changed
+```
+
+When a dependency upgrade starts wrapping `XMLHttpRequest.prototype.open`, the same command fails the build and names the package, its previous version and the line that does it:
+
+<!-- docs-test: build v2 -->
+```sh
+npx monkeypatchlist scan dist --fail-on added,changed   # exits 1
+```
+
+<!-- docs-test: output -->
+```text
+monkeypatchlist 0.1.0 · catalog 1 · Storefront · surface protected · offline
+
+Change since baseline
+  Added 1   Changed 0   Removed 0   Unconfirmed 0   Existing 2
+
+Added
+  XMLHttpRequest.prototype.open    wrap
+    Package          @example/telemetry@2.0.0
+    Previous version @example/telemetry@1.4.0
+    Source           ../../node_modules/@example/telemetry/index.js:17 (assets/main-RFTVJBC6.js:1:317)
+    Provenance       bundled dependency · load · unconditional
+    Confidence       target high · mutation high · attribution high
+    Fingerprint      window|XMLHttpRequest.prototype.open|wrap|pkg:@example/telemetry
+
+Notes
+  Window.fetch                     @example/telemetry 1.4.0 → 2.0.0
+  XMLHttpRequest.prototype.open    @example/telemetry 1.4.0 → 2.0.0
+
+Completeness   complete
+  Known 1 · analyzed 1 · failed 0 · skipped 0
+Inputs
+  Source maps  1 / 1 artifacts
+  Lockfile     package-lock.json
+Outside scope  none
+Ineffective writes 0
+
+Gate  fail-on added,changed → FAIL (1 finding)   exit 1
+```
+
+**5. Accept a change on purpose.** If the new mutation is intended, accept it into the baseline and commit the baseline with the upgrade, so the change is reviewed in the same pull request:
+
+```sh
+npx monkeypatchlist baseline update dist
+```
+
+The quickstart's build is the example in [docs/examples/storefront](docs/examples/storefront/).
+
+## A real scan
+
+This is monkeypatchlist's report for a Vite build of an app that imports the [`whatwg-fetch`](https://github.com/JakeChampion/fetch) polyfill, from the validation corpus monkeypatchlist is tested against. The polyfill installs `fetch`, `Headers`, `Request` and `Response` only where the browser lacks them, which the scan reports as `guarded-native-absence`:
+
+<!-- docs-test: corpus dist/vite/whatwg-fetch/maps -->
+```sh
+npx monkeypatchlist scan dist/vite/whatwg-fetch/maps --map https://app.corpus.test/=.
+```
+
+<!-- docs-test: output -->
+```text
+monkeypatchlist 0.1.0 · catalog 1 · maps · surface protected · offline
+
+Findings 4   (no baseline: run with --baseline to see the change)
+  Window.Headers                   replace
+    Package          whatwg-fetch
+    Introduced by    unknown (no lockfile)
+    Source           ../../../../../node_modules/whatwg-fetch/fetch.js:639 (assets/index-9dL12JRx.js:2:3031)
+    Provenance       bundled dependency · load · guarded-native-absence
+    Confidence       target high · mutation high · attribution high
+    Fingerprint      window|Window.Headers|replace|pkg:whatwg-fetch
+  Window.Request                   replace
+    Package          whatwg-fetch
+    Introduced by    unknown (no lockfile)
+    Source           ../../../../../node_modules/whatwg-fetch/fetch.js:640 (assets/index-9dL12JRx.js:2:3043)
+    Provenance       bundled dependency · load · guarded-native-absence
+    Confidence       target high · mutation high · attribution high
+    Fingerprint      window|Window.Request|replace|pkg:whatwg-fetch
+  Window.Response                  replace
+    Package          whatwg-fetch
+    Introduced by    unknown (no lockfile)
+    Source           ../../../../../node_modules/whatwg-fetch/fetch.js:641 (assets/index-9dL12JRx.js:2:3055)
+    Provenance       bundled dependency · load · guarded-native-absence
+    Confidence       target high · mutation high · attribution high
+    Fingerprint      window|Window.Response|replace|pkg:whatwg-fetch
+  Window.fetch                     replace
+    Package          whatwg-fetch
+    Introduced by    unknown (no lockfile)
+    Source           ../../../../../node_modules/whatwg-fetch/fetch.js:638 (assets/index-9dL12JRx.js:2:3021)
+    Provenance       bundled dependency · load · guarded-native-absence
+    Confidence       target high · mutation high · attribution high
+    Fingerprint      window|Window.fetch|replace|pkg:whatwg-fetch
+
+Completeness   complete
+  Known 1 · analyzed 1 · failed 0 · skipped 0
+Inputs
+  Source maps  1 / 1 artifacts
+  Lockfile     not given · no lockfile versions; Introduced by unknown
+Outside scope  other 1   (run with --surface all)
+Ineffective writes 0
+
+Gate  not run (no --fail-on)
+```
+
+## What it covers
+
+- **Tested on webpack, Vite, Rollup and esbuild.** monkeypatchlist reads build output, not bundler metadata, and recovers module structure from the code itself. Builds from other bundlers may scan with some modules left unlinked (see [Limitations](docs/limitations.md)).
+- **Real mutations only.** Assigning a writable attribute such as `location.href` is API use, not a mutation, and a write the browser rejects is recorded as ineffective, never as a finding.
+- **The APIs that matter by default.** Scans report the [protected surface](docs/concepts.md#protected-surface): networking, events, timers, navigation, storage, crypto, workers, `console` and the core ECMAScript built-ins. `--surface all` reports the whole native catalog.
+- **Honest coverage.** Every report says whether the scan was `complete`, and lists what it could not analyze.
+
+It does not run your code, crawl live sites, or look for malware. [Limitations](docs/limitations.md) lists what it can't see.
+
+## Documentation
+
+- [Getting started](docs/getting-started.md): inputs, a first scan, reading the report, adopting monkeypatchlist on an existing app
+- [CI recipes](docs/ci.md): GitHub Actions and any other CI
+- [Configuration and CLI reference](docs/configuration.md): every command, flag and config key, and the exit codes
+- [Report format](docs/report-format.md): the JSON report
+- [Concepts](docs/concepts.md): findings, fingerprints, attribution, baseline states, completeness and the protected surface
+- [Limitations](docs/limitations.md)
+
+Design decisions are recorded in [docs/adr](docs/adr/), and the vocabulary in [CONTEXT.md](CONTEXT.md). To work on monkeypatchlist, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+[Apache-2.0](LICENSE)