dsh-supply-watch 0.0.0-stage → 0.1.0

package/DESIGN.md

@@ -0,0 +1,326 @@
+# DESIGN — dsh-supply-watch
+
+Status: MVP, `0.1.0`, unpublished. License: Apache-2.0.
+
+> Unofficial community project. Not affiliated with DeepSeek.
+
+## 1. Problem and scope
+
+Supply-chain review of an npm dependency often starts with two questions that
+can be answered locally:
+
+1. **Does this name look like a trusted package?** (`dsh-core` vs. `dsh-cora`,
+   `dsh_core`, `dshcore`, `core`, `node-dsh-core`, ...)
+2. **Does its publication history look plausible?** (`0.0.1`, `99.0.0`, a
+   giant major jump, a prerelease that goes backwards, missing intermediate
+   releases)
+
+`dsh-supply-watch` answers only those questions, with deterministic heuristics
+and no network access. It is a lead generator, not an SCA product.
+
+### Goals
+
+- zero dependencies, pure ESM, Node built-ins only;
+- offline and deterministic (same input -> same output);
+- usable as a CLI and as a small library;
+- findings carry a stable code, a numeric score, and a reason;
+- conservative about claims: every output says "heuristic", never "malware".
+
+### Non-goals
+
+- registry metadata fetching or package-name reservation checks;
+- tarball download, extraction, install-script execution, or code analysis;
+- advisory matching (OSV/GHSA), signature/provenance verification;
+- dependency-graph or lockfile analysis;
+- a comprehensive Unicode confusables table;
+- replacing `npm audit`, Socket, Snyk, OSV-Scanner, Dependabot, or human review.
+
+## 2. Architecture
+
+```text
+src/core.js   pure heuristics: normalization, Levenshtein, typo scoring,
+              version parsing/anomalies, severity, watch-style merge/sort
+src/cli.js    parseArgs + file/stdout I/O + JSON; no heuristic logic
+test/         node:test, offline; core unit tests + spawned CLI tests
+```
+
+`core.js` imports nothing. `cli.js` imports only `node:fs/promises`,
+`node:util`, and `core.js`. The CLI never executes a scanned package.
+
+## 3. Name comparison
+
+### 3.1 Normalization
+
+`normalizeName(name)`:
+
+1. trim and lowercase;
+2. normalize separators inside an npm scope (`@Scope/Name` -> `@scope/name`);
+3. collapse runs of `-`, `_`, `.` into one `-`;
+4. trim leading/trailing `-`.
+
+Examples:
+
+| Input | Normalized |
+| --- | --- |
+| `  DSH__Core.Plugin  ` | `dsh-core-plugin` |
+| `dsh--core` | `dsh-core` |
+| `@DSH/Foo_Bar` | `@dsh/foo-bar` |
+
+This makes punctuation-only variants comparable while keeping scopes
+distinguishable. Scope-hopping itself (`@evil/dsh-core` for `dsh-core`) is not
+given a dedicated signal; it is documented as a limitation.
+
+### 3.2 DSH namespace prefix
+
+The prefix heuristic recognizes an optional `node-`, `deepseek-`, or
+`official-` qualifier followed by `dsh`, then either a separator or a glued
+continuation:
+
+```text
+dsh-core      -> core
+dshcore       -> core
+node-dsh-core -> core
+deepseek-dsh-core -> core
+official-dsh-core -> core
+```
+
+If the stripped cores are equal but the full normalized names differ, the
+candidate is flagged with score 74 and one of three reasons:
+
+- candidate adds a `dsh-` prefix (`dsh-core` vs. known `core`);
+- candidate omits it (`core` vs. known `dsh-core`);
+- candidate uses a different prefix form (`node-dsh-core` vs. `dsh-core`).
+
+The prefix signal intentionally has a moderate score: adding `dsh-` to an
+unrelated official name is suspicious, but many legitimate companion packages
+share a prefix.
+
+### 3.3 Signal order and scores
+
+For a normalized candidate and one known name, signals are evaluated and the
+highest score wins. Ties keep the earlier signal (a deterministic, documented
+priority).
+
+| Signal | Score | Notes |
+| --- | ---: | --- |
+| exact known name | 0 | checked globally first; never flagged |
+| separator/punctuation variant (normalized equal) | 90 | `dsh_core`, `dsh--core` |
+| same compact form (separators removed) | 88 | `dshcore` |
+| Levenshtein distance 1, max length >= 4 | 88 | typical typo |
+| Levenshtein distance 2, max length >= 5 | 68 | e.g. transposition |
+| prefix add/omit/respell | 74 | see 3.2 |
+| Levenshtein distance 3, max length >= 9 | 46 | longer names only |
+| extra trailing segment | 44 | `dsh-core-utils` |
+| extra glued suffix (3+ chars) | 42 | `dshcoreutils` |
+| no signal | 0 | `no close match among N ...` |
+
+Why these thresholds:
+
+- Short names are edit-distance minefields. Below the length thresholds, only
+  punctuation/prefix signals are trusted.
+- Distance 3 is only used for long names, where three edits are a small
+  fraction of the name.
+- Extension signals are deliberately low severity: a name that extends a
+  trusted package is a plausible lead, not proof of impersonation.
+- Exact matches short-circuit across the *whole* known list. If both `core`
+  and `dsh-core` are trusted, the candidate `core` is not flagged for omitting
+  a prefix from its sibling.
+
+`typosquatScore` returns the best entry by score, then by lowest distance,
+then by known-list order. `nearest` is the original known string; `distance`
+is computed on normalized names. With no known list (or an empty name), the
+result has `nearest: null`, `distance: null`, `score: 0` and a reason.
+
+### 3.4 Levenshtein
+
+`levenshtein(a, b)` is a standard dynamic-programming implementation that
+iterates over the shorter string internally. The optional
+`{ maxDistance }` (or numeric third argument) enables a banded computation:
+
+- cells outside `|i - j| <= maxDistance` are capped;
+- a row whose minimum exceeds the threshold aborts early;
+- the return value is `maxDistance + 1` when the true distance exceeds the
+  bound, instead of the exact distance.
+
+This convention is documented because callers must not treat the sentinel as
+an exact distance. Fuzz tests compare the banded result with the full DP for
+random strings and thresholds (see §8).
+
+## 4. Version analysis
+
+### 4.1 Input and parsing
+
+Input is a list of semver-ish strings, expected in **publication order
+(oldest first)**. Accepted shape:
+
+```text
+v?MAJOR.MINOR.PATCH(-PRERELEASE)?(+BUILD)?
+```
+
+Build metadata is ignored. Numeric prerelease identifiers compare numerically;
+alphanumeric identifiers compare lexically; a prerelease is lower than its
+stable release (SemVer 2.0.0). Invalid entries are ignored rather than guessed
+at. Duplicate versions are deduplicated for structural checks.
+
+### 4.2 Structural checks (order-independent)
+
+A copy is filtered to stable versions and sorted ascending.
+
+| Code | Condition | Score |
+| --- | --- | ---: |
+| `placeholder-version` | `0.0.0` or `0.0.1` | 52 |
+| `implausible-major` | major `>= 99` | 92 |
+| `major-jump` | consecutive majors differ by `>= 2` (current major < 99) | 85 if jump >= 5, else 70 |
+| `missing-intermediate` (minor) | same major, minor gap `>= 2` | 45 |
+| `missing-intermediate` (patch) | same major/minor, patch gap `>= 2` | 35 |
+
+`missing-intermediate` findings include `missingCount` and up to five example
+versions/lines (`1.1.x`, `1.0.1`) so output stays bounded even for huge gaps.
+Major jumps do not also emit missing-minor findings; they are different
+signals for the same gap.
+
+### 4.3 Publication-order checks
+
+These iterate the parsed list as supplied, without sorting:
+
+| Code | Condition | Score |
+| --- | --- | ---: |
+| `prerelease-rollback` | current version has a prerelease and sorts below previous | 86 |
+| `version-regression` | any other decrease from previous to current | 82 |
+
+Sorting for structural checks while preserving original order for rollback
+checks is a deliberate split: jumps/gaps are properties of the set, while a
+rollback is a property of the publish sequence. Passing an unsorted list will
+therefore produce noisy rollback findings; callers should sort first or pass
+the real npm publication history.
+
+### 4.4 Why 99.x is special
+
+An enormous major version is a classic dependency-confusion bait (it wins
+naive "highest version" resolution). The `>= 99` threshold is a heuristic; a
+real project could legitimately reach it. When the current major is `>= 99`,
+the separate major-jump finding is suppressed to avoid "skips 98 majors"
+noise.
+
+## 5. Severity and merging
+
+`severityOf(finding)`:
+
+- returns an explicit valid `severity` if present;
+- otherwise maps score `>= 80` -> `high`, `>= 50` -> `medium`, else `low`.
+
+`watch(names, known)` accepts `string` or `{ name, versions }` entries,
+attaches the name to version findings, adds `severity`, and sorts:
+
+1. severity rank (`high`, `medium`, `low`);
+2. score descending;
+3. name ascending;
+4. code/kind ascending (stable tie-break).
+
+Typo findings are emitted only when `score > 0`. Version findings with an
+empty version list are not emitted. An empty/missing known list disables typo
+checks but leaves version checks active. Empty input returns `[]`.
+
+## 6. CLI behavior
+
+```text
+dsh-supply-watch check <name> [--known a,b] [--versions x,y] [--json]
+dsh-supply-watch scan <names.txt> [--known a,b] [--json]
+dsh-supply-watch --help
+```
+
+- `check` builds a one-element watch input; `scan` parses lines, ignores
+  blanks and `#` comments, and accepts optional comma/space-separated versions
+  after the name.
+- `--json` writes one JSON object to stdout; warnings go to stderr so stdout
+  remains parseable.
+- No `--known` -> stderr note; typo analysis is inactive.
+- Exit code `0` means the command ran, **not** that the package is safe.
+  Usage/IO errors exit `1`. Findings do not fail the process; CI policy is the
+  caller's job.
+- The CLI intentionally has no built-in trusted list and makes no network
+  calls.
+
+## 7. False positives / false negatives
+
+### Expected false positives
+
+- legitimate extension packages (`dsh-core-utils`);
+- intentional prefix differences (a non-DSH package named `core`);
+- version resets (project rewrite at `2.0.0` after `1.x`);
+- yanked versions creating real gaps;
+- `0.0.1` prototypes;
+- publication lists that are not chronological.
+
+Mitigation: every finding carries a reason and score; consumers should treat
+scores as ranking hints and review context. Findings are not verdicts.
+
+### Expected false negatives
+
+- homoglyphs and mixed-script names not covered by Levenshtein (e.g. Cyrillic
+  lookalikes);
+- impersonation more than three edits away;
+- scope-hopping (`@evil/dsh-core`);
+- compromised *official* packages, malicious install scripts, vulnerable
+  dependency graphs;
+- malicious versions that happen to be semver-plausible;
+- typos in names shorter than the edit-distance thresholds.
+
+These are inherent to a local heuristic MVP. Closing them requires registry
+metadata, tarball analysis, provenance/signature verification, and advisory
+data — explicitly out of scope and not faked here.
+
+## 8. Testing
+
+`node --test test/*.test.js` (also runnable from the suite root with the
+glob) covers:
+
+- Levenshtein basics, empty strings, and the early-exit sentinel (plus a
+  development-time fuzz check against full DP for randomized inputs);
+- normalization, including scopes and repeated separators;
+- exact/known short-circuit, punctuation variants, glued names, prefix
+  omission/difference, extra segments, one-edit typos, multiple candidates;
+- empty known list, empty names, unrelated names;
+- all version codes, duplicate/invalid versions, forward prerelease history,
+  clean history;
+- severity mapping, deterministic sorting, tie-breaking by score;
+- CLI help, JSON for `check`/`scan`, comments/blanks, missing known list,
+  unknown command, missing input, unreadable file, and exit codes.
+
+Tests are offline and use only `%TEMP%`-style temporary directories for scan
+fixtures (created with `mkdtemp` and removed afterward).
+
+## 9. Security and performance
+
+- No third-party dependencies and no network calls: nothing to trust beyond
+  Node and this source.
+- No evaluation of package contents; scanned names/versions are only compared
+  and printed. JSON output uses `JSON.stringify`, so quotes/newlines in input
+  are escaped.
+- O(names × known × name-length²) name comparison; names are short. The
+  Levenshtein banded mode is available for callers with large candidate sets.
+- Version history is bounded in output examples (`missing` samples capped at
+  five) but all versions are parsed; pathological multimegabyte lists are the
+  caller's responsibility.
+
+## 10. Future work
+
+Only after the limitations above are addressed explicitly:
+
+- optional registry adapter (opt-in; never required for offline use);
+- conservative homoglyph/confusables normalization with a documented table;
+- scope-hopping signal with allowlists;
+- SARIF/JSON schema for CI ingestion;
+- richer package metadata (maintainers, provenance, publish times) via a
+  separately audited data source.
+
+None of these are implemented in `0.1.0`; this document is not a claim that
+they exist.
+
+## 11. Naming and distribution
+
+- Package name: `dsh-supply-watch`.
+- npm availability was checked on 2026-11-14 (`npm view dsh-supply-watch` ->
+  `E404 Not Found`); this is a point-in-time observation, not a reservation.
+- License: Apache-2.0.
+- Unofficial: not affiliated with DeepSeek.

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.