@openreachtech/mentsu-npm-audit-gate 0.0.0-stage → 0.1.0

package/LICENSE

@@ -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 2026 Open Reach Tech Inc.
+
+   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/README.ja.md

@@ -0,0 +1,124 @@
+# @openreachtech/mentsu-npm-audit-gate
+
+`npm audit` の結果を判定するゲートです。
+
+## コンセプト
+
+`npm audit` は見つけた advisory をすべて報告しますが、パッチ版のない advisory を抱えたまま進めざるを得ないことがあります。このパッケージは `npm audit` を実行し、あなたが挙げた advisory だけを通し、それ以外は重大度を問わず失敗とします。
+
+リストの各項目は、通す理由と、外す条件を持ちます。リストに挙がっているのにもうレポートされない項目も失敗とするので、リストが理由より長生きすることはありません。
+
+## インストール
+
+Node.js 24.19.0 以上が必要です。
+
+```sh
+npm install @openreachtech/mentsu-npm-audit-gate
+```
+
+ES モジュール（`"type": "module"`）です。ESM の `import` 構文でインポートしてください。
+
+## 使い方
+
+リストを `NpmAuditGate` に渡すスクリプトを書き、`npm audit` を判定したいプロジェクトで実行します。
+
+リストの項目を検査するには、型ファイルをプロジェクトで 1 度だけ取り込みます。そのうえで、リストに `NpmAuditType.IgnoredAdvisory` を付けます。
+
+```js
+// types/env/npm-audit-gate.d.ts
+import '@openreachtech/mentsu-npm-audit-gate/types/index.d.ts'
+```
+
+```js
+import {
+  NpmAuditGate,
+} from '@openreachtech/mentsu-npm-audit-gate'
+
+/**
+ * @type {Array<NpmAuditType.IgnoredAdvisory>}
+ */
+const IGNORED_ADVISORIES = [
+  {
+    id: 'GHSA-aaaa-bbbb-cccc',
+    package: 'alpha-package',
+    path: 'beta-package > alpha-package',
+    reason: 'No patched release exists, and the package is reached through a development dependency only',
+    removeWhen: 'alpha-package publishes a release outside the affected range',
+  },
+]
+
+const alphaGate = NpmAuditGate.create({
+  ignoredAdvisories: IGNORED_ADVISORIES,
+})
+
+process.exitCode = alphaGate.auditAdvisories()
+```
+
+リストに挙がっていない advisory がレポートされたとき、リストの項目がレポートされなくなったとき、`npm audit` がレポートを返さなかったときは、終了コード 1 で終わります。それ以外は 0 で終わります。
+
+`NpmAuditType` のほかの型（クラスごとに、そのクラスの名前の型と、その `Ctor`）は、このパッケージの JSDoc を読むので、使うプロジェクトでは、`jsconfig.json` に `allowJs: true` と、3 以上の `maxNodeModuleJsDepth` が必要です。
+
+### パッケージが配布するスクリプトの実行
+
+監査を実行するスクリプトはパッケージが配布しているので、リポジトリごとにコピーを持つ必要はありません。`package.json` の script から、パスを指定して呼び出してください。
+
+通す advisory を挙げたファイルを、唯一の引数として渡します。ファイルの既定のエクスポートは配列です。
+
+```js
+// scripts/stopgap-audit/IGNORED_ADVISORIES.js
+export default [
+  {
+    id: 'GHSA-aaaa-bbbb-cccc',
+    package: 'alpha-package',
+    path: 'beta-package > alpha-package',
+    reason: 'No patched release exists, and the package is reached through a development dependency only',
+    removeWhen: 'alpha-package publishes a release outside the affected range',
+  },
+]
+```
+
+```json
+{
+  "scripts": {
+    "audit:npm": "node node_modules/@openreachtech/mentsu-npm-audit-gate/scripts/npm-audit-gate.js scripts/stopgap-audit/IGNORED_ADVISORIES.js"
+  }
+}
+```
+
+ファイルは、作業ディレクトリ基準で解決します。ファイルが無ければ、スクリプトは失敗します。
+
+終了コードは `NpmAuditGate` と同じで、リストを読み込めなかったときも 1 で終わります。
+
+このパッケージは、コマンド名を意図して宣言していません。コマンド名は、インストールした全パッケージが共有する `node_modules/.bin/` で解決されるので、同じ名前を宣言した別のパッケージに、警告なしで奪われます。パスは、このパッケージだけを指します。
+
+## API
+
+[API リファレンス](https://github.com/openreachtech/mentsu-npm-audit-gate/blob/main/docs/ja/api/index.ja.md)
+
+## コントリビューション
+
+バグ報告・機能要望・コード貢献を歓迎します。
+
+GitHub Issues からお気軽にご連絡ください。
+
+```sh
+git clone https://github.com/openreachtech/mentsu-npm-audit-gate.git
+cd mentsu-npm-audit-gate
+npm install
+npm run lint
+npm test
+```
+
+## ライセンス
+
+本プロジェクトは Apache License 2.0 で公開されています。
+
+詳細は [LICENSE ファイル](./LICENSE) を参照してください。
+
+## 開発者
+
+[Open Reach Tech Inc.](https://openreach.tech)
+
+## 著作権
+
+© 2026 Open Reach Tech Inc.

package/README.md

@@ -1,3 +1,124 @@
-# Temporary Holding Version
+# @openreachtech/mentsu-npm-audit-gate
 
-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.
+Gate that checks the result of `npm audit`.
+
+## Concept
+
+`npm audit` reports every advisory it finds, and a project sometimes has to live with one that has no patched release. This package runs `npm audit`, lets through only the advisories you list, and fails on everything else, at any severity.
+
+Each entry of the list carries its reason and the condition for removing it. An entry whose advisory is no longer reported fails the audit too, so the list cannot outlive the reasons it was written for.
+
+## Installation
+
+Requires Node.js 24.19.0 or later.
+
+```sh
+npm install @openreachtech/mentsu-npm-audit-gate
+```
+
+It is an ES module (`"type": "module"`); import it with ESM `import` syntax.
+
+## Usage
+
+Write a script that hands the list to `NpmAuditGate`, and run it in the project whose `npm audit` it should judge.
+
+To check the entries of the list, import the type file once in your project. Then annotate the list with `NpmAuditType.IgnoredAdvisory`.
+
+```js
+// types/env/npm-audit-gate.d.ts
+import '@openreachtech/mentsu-npm-audit-gate/types/index.d.ts'
+```
+
+```js
+import {
+  NpmAuditGate,
+} from '@openreachtech/mentsu-npm-audit-gate'
+
+/**
+ * @type {Array<NpmAuditType.IgnoredAdvisory>}
+ */
+const IGNORED_ADVISORIES = [
+  {
+    id: 'GHSA-aaaa-bbbb-cccc',
+    package: 'alpha-package',
+    path: 'beta-package > alpha-package',
+    reason: 'No patched release exists, and the package is reached through a development dependency only',
+    removeWhen: 'alpha-package publishes a release outside the affected range',
+  },
+]
+
+const alphaGate = NpmAuditGate.create({
+  ignoredAdvisories: IGNORED_ADVISORIES,
+})
+
+process.exitCode = alphaGate.auditAdvisories()
+```
+
+The process ends with exit code 1 when an advisory the list does not name is reported, when an entry of the list is no longer reported, or when `npm audit` answers with no report. Otherwise it ends with 0.
+
+The other types of `NpmAuditType` (one for each class, named after it, and its `Ctor`) read the JSDoc of this package, so a project that uses them needs `allowJs: true` and `maxNodeModuleJsDepth` of 3 or more in its `jsconfig.json`.
+
+### Running the script shipped with the package
+
+The package ships the script that runs the audit, so a repository does not need to carry a copy of it. Call it by its path from a script of `package.json`.
+
+Pass the file that lists the ignored advisories as the only argument. Its default export is the array.
+
+```js
+// scripts/stopgap-audit/IGNORED_ADVISORIES.js
+export default [
+  {
+    id: 'GHSA-aaaa-bbbb-cccc',
+    package: 'alpha-package',
+    path: 'beta-package > alpha-package',
+    reason: 'No patched release exists, and the package is reached through a development dependency only',
+    removeWhen: 'alpha-package publishes a release outside the affected range',
+  },
+]
+```
+
+```json
+{
+  "scripts": {
+    "audit:npm": "node node_modules/@openreachtech/mentsu-npm-audit-gate/scripts/npm-audit-gate.js scripts/stopgap-audit/IGNORED_ADVISORIES.js"
+  }
+}
+```
+
+The file is resolved against the working directory, and the script fails when it is missing.
+
+It ends with the same exit codes as `NpmAuditGate`, and with 1 as well when the list cannot be loaded.
+
+The package declares no command name on purpose. A command name is resolved through `node_modules/.bin/`, which every installed package shares, and another package that declares the same name takes it over without any warning. The path names this package alone.
+
+## API
+
+[API reference](https://github.com/openreachtech/mentsu-npm-audit-gate/blob/main/docs/en/api/index.md)
+
+## Contribution
+
+Bug reports, feature requests, and code contributions are welcome.
+
+Feel free to contact us through GitHub Issues.
+
+```sh
+git clone https://github.com/openreachtech/mentsu-npm-audit-gate.git
+cd mentsu-npm-audit-gate
+npm install
+npm run lint
+npm test
+```
+
+## License
+
+This project is released under the Apache License 2.0.
+
+For more details, please see [in the LICENSE file](./LICENSE).
+
+## Developer
+
+[Open Reach Tech Inc.](https://openreach.tech)
+
+## Copyright
+
+© 2026 Open Reach Tech Inc.

package/lib/AuditFetcher.js

@@ -0,0 +1,134 @@
+import nodeChildProcess from 'node:child_process'
+
+import ProcessLogger from './ProcessLogger.js'
+
+/**
+ * Largest output `npm audit` may produce, in bytes.
+ *
+ * @type {number}
+ */
+const MAX_AUDIT_OUTPUT_BYTES = 64 * 1024 * 1024
+
+/**
+ * Fetch the report `npm audit --json` prints.
+ */
+export default class AuditFetcher {
+  /**
+   * @param {{
+   *   childProcess: typeof nodeChildProcess
+   *   processLogger: ProcessLogger
+   * }} params - Parameters of this constructor.
+   */
+  constructor ({
+    childProcess,
+    processLogger,
+  }) {
+    this.childProcess = childProcess
+    this.processLogger = processLogger
+  }
+
+  /**
+   * Factory method.
+   *
+   * @template {X extends typeof AuditFetcher ? X : never} T, X
+   * @param {{
+   *   childProcess?: typeof nodeChildProcess
+   *   processLogger?: ProcessLogger
+   * }} [params] - Parameters for the factory method.
+   * @returns {InstanceType<T>} Instance of this class.
+   * @this {T}
+   * @public
+   */
+  static create ({
+    childProcess = this.childProcess,
+    processLogger = this.createProcessLogger(),
+  } = {}) {
+    return /** @type {InstanceType<T>} */ (
+      new this({
+        childProcess,
+        processLogger,
+      })
+    )
+  }
+
+  /**
+   * get: `node:child_process` module.
+   *
+   * @returns {typeof nodeChildProcess} `node:child_process` module.
+   */
+  static get childProcess () {
+    return nodeChildProcess
+  }
+
+  /**
+   * get: Constructor of `ProcessLogger`.
+   *
+   * @returns {typeof ProcessLogger} Constructor of `ProcessLogger`.
+   */
+  static get ProcessLoggerCtor () {
+    return ProcessLogger
+  }
+
+  /**
+   * Create a `ProcessLogger`.
+   *
+   * @returns {ProcessLogger} Instance of `ProcessLogger`.
+   */
+  static createProcessLogger () {
+    return this.ProcessLoggerCtor.create()
+  }
+
+  /**
+   * Fetch the report `npm audit --json` prints.
+   *
+   * @returns {AuditReport | null} Report, or null when npm printed none.
+   * @public
+   */
+  fetchReport () {
+    const auditResult = this.childProcess.spawnSync(
+      'npm',
+      [
+        'audit',
+        '--json',
+      ],
+      {
+        encoding: 'utf8',
+        maxBuffer: MAX_AUDIT_OUTPUT_BYTES,
+      }
+    )
+
+    // npm exits 1 whenever it finds an advisory, so only its stdout says whether a report came back.
+    try {
+      return JSON.parse(auditResult.stdout)
+    } catch {
+      this.processLogger.logError({
+        text: auditResult.stderr,
+      })
+
+      return null
+    }
+  }
+}
+
+/**
+ * @typedef {{
+ *   name: string
+ *   severity: string
+ *   range: string
+ *   title: string
+ *   url: string
+ * }} AuditAdvisory
+ */
+
+/**
+ * @typedef {{
+ *   error?: *
+ *   vulnerabilities?: Record<string, {
+ *     via: Array<string | AuditAdvisory>
+ *   }>
+ * }} AuditReport
+ */
+
+/**
+ * @typedef {*} BooleanLike
+ */