safetyvibe-connect 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +176 -167
- package/README.md +176 -167
- package/SECURITY.md +5 -2
- package/cli.mjs +81 -38
- package/lib.mjs +283 -76
- package/package.json +4 -4
package/AGENTS.md
CHANGED
|
@@ -1,167 +1,176 @@
|
|
|
1
|
-
# SafetyVibe Connect instructions
|
|
2
|
-
|
|
3
|
-
SafetyVibe Connect reads package.json, the lockfile, and client-exposed Supabase config (client-prefixed env vars and the client Supabase file). It reports your package list so we can warn you about vulnerable dependencies. The JSON body sends exactly: v, optional name, url, platform and environment, lockfile, versions_source, source, packages, optional truncated, and supabase (null, or project_ref and host with key_kind and key_fingerprint, or secret_key_exposed_client_side).
|
|
4
|
-
|
|
5
|
-
Full source: https://safetyvibe.eu/connect/source/0.3.
|
|
6
|
-
|
|
7
|
-
## 0.3.
|
|
8
|
-
|
|
9
|
-
For a manual no-install inventory, ask: "Show me a safe inventory summary and JSON from package.json and a supported lockfile; I will review it locally." Request no installation, execution, file changes, keys or environment values. Unknown facts stay unknown. Review the output locally; dashboard paste acceptance and save/refresh compatibility require separate verification, including exposed-secret flags and declaration whitespace.
|
|
10
|
-
|
|
11
|
-
With Node and a terminal, run without adding the connector to your project (npx fetches and executes the package):
|
|
12
|
-
|
|
13
|
-
```sh
|
|
14
|
-
npx -y safetyvibe-connect@0.3.
|
|
15
|
-
npx -y safetyvibe-connect@0.3.
|
|
16
|
-
npx -y safetyvibe-connect@0.3.
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
`inventory` always makes no network call and writes nothing unless you pass `--out`. It does not install the connector, add hooks or update link settings. Warnings and guidance stay on stderr when stdout contains JSON. Compact JSON is one line and retains every inventory row (up to the existing 5000-row cap). This prepares a reviewable inventory; it does not establish dashboard acceptance.
|
|
20
|
-
|
|
21
|
-
Common subprojects (frontend, client, web, apps/*) and declared npm/pnpm workspace members are suggested. Discovery is bounded to six levels and 500 entries, skips symlink directories, and never merges projects or changes the selected/linked app. Use `--project DIR` to explicitly select one existing package.json directory inside the current root, or change directories yourself. Exports/config writes apply to that selected directory.
|
|
22
|
-
|
|
23
|
-
Flag precedence is independent of order: `--summary` or `--json=summary` wins over JSON stdout; `--out` still exports the full body and suppresses JSON stdout; `--json` opts into full JSON. `--compact` only changes JSON formatting and does not enable JSON by itself. An explicit summary plus --out prints a summary and exports the body. Other --out modes keep stdout empty. Real --json reports print the safe request body on stdout and connection/guidance text on stderr.
|
|
24
|
-
|
|
25
|
-
Counts are local summary metadata, not new JSON fields. Direct means safe registry declarations in the selected package.json. Total means unique name+resolved-version rows in the selected lockfile before truncation; declared means manifest rows when no usable lock exists. The summary separately shows direct dev declarations and confirmed dev-only inventory rows. Yarn v1 resolves direct dev selectors and suppresses the flag for runtime-reachable shared entries; unclassified transitive packages are not labelled dev-only. Shared workspace Yarn locks retain unknown dev-only status because other apps may use those packages at runtime. A shared workspace lock may cover more than the selected app, so its total is explicitly a lockfile total.
|
|
26
|
-
|
|
27
|
-
When no usable lock exists, safe package.json ranges are preserved verbatim with `versions_source:"declared"` and `lockfile:"none"`. No resolved versions or successful vulnerability checks are invented. Recognized empty or fully excluded locks remain authoritative. Declared bodies (including empty declared inventories) are kept local until dashboard range handling and save/refresh behavior are verified. Real `setup` refuses them with exit 1 before any network call, config migration, link-setting write or hook change; real `scan` emits the same warning and exits 0 for install hooks. This guard also applies with `--json`: a refused real run prints no JSON on stdout. `inventory` and `setup --dry-run` still preview them. An explicit `--out` export is processed before the guard and can write the requested local JSON even when the real report is refused (invalid output paths exit 2). Supply a supported lockfile to send a resolved inventory.
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
#
|
|
38
|
-
|
|
39
|
-
#
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
`
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
It reads and
|
|
56
|
-
|
|
57
|
-
Client
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
- src/
|
|
62
|
-
- src/
|
|
63
|
-
- lib/supabase.ts
|
|
64
|
-
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
"
|
|
92
|
-
"
|
|
93
|
-
"
|
|
94
|
-
"
|
|
95
|
-
"
|
|
96
|
-
"
|
|
97
|
-
"
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
- `
|
|
104
|
-
- `
|
|
105
|
-
- `
|
|
106
|
-
- `
|
|
107
|
-
- `
|
|
108
|
-
- `
|
|
109
|
-
- `
|
|
110
|
-
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
1
|
+
# SafetyVibe Connect instructions
|
|
2
|
+
|
|
3
|
+
SafetyVibe Connect reads package.json, the lockfile, and client-exposed Supabase config (client-prefixed env vars and the client Supabase file). It reports your package list so we can warn you about vulnerable dependencies. The JSON body sends exactly: v, optional name, url, platform and environment, lockfile, versions_source, source, packages, optional truncated and local-only incomplete, and supabase (null, or project_ref and host with key_kind and key_fingerprint, or secret_key_exposed_client_side). The report body contains no raw Supabase keys or file contents. Metadata is screened for known key/token shapes; screening cannot identify every possible secret. Review local JSON before reporting. Requires Node >=18; no dependencies or package install scripts.
|
|
4
|
+
|
|
5
|
+
Full source: https://safetyvibe.eu/connect/source/0.3.3
|
|
6
|
+
|
|
7
|
+
## 0.3.3: review an inventory locally
|
|
8
|
+
|
|
9
|
+
For a manual no-install inventory, ask: "Show me a safe inventory summary and JSON from package.json and a supported lockfile; I will review it locally." Request no installation, execution, file changes, keys or environment values. Unknown facts stay unknown. Review the output locally; dashboard paste acceptance and save/refresh compatibility require separate verification, including exposed-secret flags and declaration whitespace.
|
|
10
|
+
|
|
11
|
+
With Node and a terminal, run without adding the connector to your project (npx fetches and executes the package):
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npx -y safetyvibe-connect@0.3.3 inventory --json --compact
|
|
15
|
+
npx -y safetyvibe-connect@0.3.3 inventory --project frontend --json --compact
|
|
16
|
+
npx -y safetyvibe-connect@0.3.3 setup --dry-run --json
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
`inventory` always makes no network call and writes nothing unless you pass `--out`. It does not install the connector, add hooks or update link settings. Warnings and guidance stay on stderr when stdout contains JSON. Compact JSON is one line and retains every inventory row (up to the existing 5000-row cap). This prepares a reviewable inventory; it does not establish dashboard acceptance.
|
|
20
|
+
|
|
21
|
+
Common subprojects (frontend, client, web, apps/*) and declared npm/pnpm workspace members are suggested. Discovery is bounded to six levels and 500 entries, skips symlink directories, and never merges projects or changes the selected/linked app. Use `--project DIR` to explicitly select one existing package.json directory inside the current root, or change directories yourself. Exports/config writes apply to that selected directory. Selection is canonicalized by realpath. An escaping read symlink or junction stops the whole report before any network request or config write; it does not merely skip that file. Internal read links are permitted. Only the documented ancestor workspace metadata and lockfiles use an explicit ancestor boundary. Connector config files and .gitignore refuse symlinks/junctions even within the project, and multiply hard-linked file targets are refused. The same write checks apply to package.json when adding a hook. Checks run before requests and again at config writes; they are pathname checks, not protection against concurrent filesystem replacement.
|
|
22
|
+
|
|
23
|
+
Flag precedence is independent of order: `--summary` or `--json=summary` wins over JSON stdout; `--out` still exports the full body and suppresses JSON stdout; `--json` opts into full JSON. `--compact` only changes JSON formatting and does not enable JSON by itself. An explicit summary plus --out prints a summary and exports the body. Other --out modes keep stdout empty. Real --json reports print the safe request body on stdout and connection/guidance text on stderr.
|
|
24
|
+
|
|
25
|
+
Counts are local summary metadata, not new JSON fields. Direct means safe registry declarations in the selected package.json. Total means unique name+resolved-version rows in the selected lockfile before truncation; declared means manifest rows when no usable lock exists. The summary separately shows direct dev declarations and confirmed dev-only inventory rows. Yarn v1 resolves direct dev selectors and suppresses the flag for runtime-reachable shared entries; unclassified transitive packages are not labelled dev-only. Shared workspace Yarn locks retain unknown dev-only status because other apps may use those packages at runtime. A shared workspace lock may cover more than the selected app, so its total is explicitly a lockfile total.
|
|
26
|
+
|
|
27
|
+
When no usable lock exists, safe package.json ranges are preserved verbatim with `versions_source:"declared"` and `lockfile:"none"`. No resolved versions or successful vulnerability checks are invented. Recognized empty or fully excluded locks remain authoritative. Declared bodies (including empty declared inventories) are kept local until dashboard range handling and save/refresh behavior are verified. Real `setup` refuses them with exit 1 before any network call, config migration, link-setting write or hook change; real `scan` emits the same warning and exits 0 for install hooks. This guard also applies with `--json`: a refused real run prints no JSON on stdout. `inventory` and `setup --dry-run` still preview them. An explicit `--out` export is processed before the guard and can write the requested local JSON even when the real report is refused (invalid output paths exit 2). Supply a supported lockfile to send a resolved inventory.
|
|
28
|
+
|
|
29
|
+
Malformed or screened registry records can leave a partial inventory. Local JSON then includes `incomplete: true`; `inventory` and `setup --dry-run` warn on stderr even with `--quiet`. Real setup/scan refuse incomplete bodies before network, config migration, link-setting writes or hook changes: setup exits 1 and scan exits 0 for install-hook compatibility. A refused real `--json` run prints no JSON on stdout. An explicit `--out` export still runs before this guard. Local warnings distinguish unidentified package sources from values excluded by safety screening. An unsupported resolution shape may need a connector correction rather than a lockfile change. Review the partial inventory locally. Valid semver prerelease and build identifiers can contain long hashes; known provider-token prefixes remain screened. Review again; never treat the partial list as an authoritative empty inventory. Receiver acceptance and preservation of prior findings require separate verification before pasting local JSON.
|
|
30
|
+
|
|
31
|
+
## 0.3.3: connect without adding a dependency
|
|
32
|
+
|
|
33
|
+
Get a claim token from the dashboard, then run:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
npx -y safetyvibe-connect@0.3.3 setup --no-hook --claim-token <TOKEN>
|
|
37
|
+
# pnpm
|
|
38
|
+
pnpm dlx safetyvibe-connect@0.3.3 setup --no-hook --claim-token <TOKEN>
|
|
39
|
+
# bun
|
|
40
|
+
bunx safetyvibe-connect@0.3.3 setup --no-hook --claim-token <TOKEN>
|
|
41
|
+
# yarn
|
|
42
|
+
yarn dlx safetyvibe-connect@0.3.3 setup --no-hook --claim-token <TOKEN>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Add `--url <published URL>` if known. Without a token, setup prints a claim link.
|
|
46
|
+
On Replit/pnpm projects, `npm install` can fail with "Cannot read properties of null (reading 'isDescendantOf')".
|
|
47
|
+
Use `pnpm add -D safetyvibe-connect@0.3.3`, or run without installing:
|
|
48
|
+
`npx -y safetyvibe-connect@0.3.3 setup --no-hook --claim-token <TOKEN>`.
|
|
49
|
+
Optional installation commands: `npm install -D safetyvibe-connect@0.3.3`, `pnpm add -D safetyvibe-connect@0.3.3`, `bun add -d safetyvibe-connect@0.3.3`, `yarn add -D safetyvibe-connect@0.3.3`.
|
|
50
|
+
|
|
51
|
+
## Local inspection and data boundaries
|
|
52
|
+
|
|
53
|
+
`setup --dry-run` makes no network call and writes nothing unless you pass `--out`. Check cli.mjs line 224: `return 0;` inside `if (flags['dry-run'])`. This exits before the only `fetch(` call. This describes the connector itself; fetching the package with npx is separate.
|
|
54
|
+
|
|
55
|
+
It reads package.json and one supported lockfile (package-lock.json, npm-shrinkwrap.json, bun.lock, pnpm-lock.yaml or yarn.lock). It may inspect candidate locks and ancestor package.json / pnpm-workspace.yaml files to select a workspace lock, stopping at .git or six parent levels. It checks whether bun.lockb exists, but does not parse it. It reads .safetyviberc.json and .safetyviberc.local.json for local link settings.
|
|
56
|
+
|
|
57
|
+
It reads and parses .env, .env.local, .env.production and .env.production.local locally, not just their key names. Service-role variable names produce local warnings. Client-prefixed values are checked for secret shapes; SUPABASE_URL, SUPABASE_PUBLISHABLE_KEY and SUPABASE_ANON_KEY with VITE_, NEXT_PUBLIC_, EXPO_PUBLIC_, PUBLIC_, REACT_APP_ or NUXT_PUBLIC_ prefixes supply the URL and public key used locally for a fingerprint. Process env is inspected the same way. Server-only Supabase values are not selected as connection details. For platform detection it also examines URL values in .env, .env.local and .env.production in the root and frontend/; those values are not sent.
|
|
58
|
+
|
|
59
|
+
Client files scanned for the Supabase URL and key shape, exactly:
|
|
60
|
+
|
|
61
|
+
- src/integrations/supabase/client.ts
|
|
62
|
+
- src/integrations/supabase/client.js
|
|
63
|
+
- src/lib/supabase.ts
|
|
64
|
+
- src/lib/supabase.js
|
|
65
|
+
- lib/supabase.ts
|
|
66
|
+
- utils/supabase.ts
|
|
67
|
+
|
|
68
|
+
Files marked server-only or use server are excluded. Bare prefixes and incomplete JWTs are ignored for secret detection. Full identifiable secrets are flagged even when embedded in larger values, comparisons, validation calls or comments in client files. Source scanning uses a forward token pass with bounded JWT candidates. Only a full sb_secret_ shape (at least 20 body characters), a three-segment service_role JWT, or a JWT with any role other than anon under a publishable/anon key name sets the exposure flag. Unknown keys are never accepted as public.
|
|
69
|
+
|
|
70
|
+
Platform detection also reads metadata.json and vite.config.ts/js/mjs/mts, package names/dependencies, and checks .lovable, .replit, .bolt, .emergent, .softgen, .leap, .rocket and .v0 markers. The CLI uses cwd / INIT_CWD, package manager and automation/CI environment hints, plus SAFETYVIBE_API, SAFETYVIBE_URL, SAFETYVIBE_ENV, NODE_ENV, SAFETYVIBE_KEY, SAFETYVIBE_CLAIM_TOKEN and SAFETYVIBE_TIMEOUT_MS. No source files or raw Supabase keys are sent. The complete JSON field list and authentication headers are documented below under "Exactly what is sent".
|
|
71
|
+
|
|
72
|
+
Source: https://safetyvibe.eu/connect/source/0.3.3
|
|
73
|
+
|
|
74
|
+
## Exactly what is sent
|
|
75
|
+
|
|
76
|
+
Preview the report before sending it:
|
|
77
|
+
|
|
78
|
+
```sh
|
|
79
|
+
npx -y safetyvibe-connect@0.3.3 setup --dry-run --json --url https://notes.example.com
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
By default non-TTY and automation/CI runs print five summary lines on stdout plus one Next guidance line: Platform, Lockfile (direct / total or declared counts, direct dev and confirmed dev-only counts), Supabase (fingerprint or exposed-secret flag only), Keys sent: 0, and Dry run: nothing sent. Warnings go to stderr. Use --json for the full body on stdout, with summary, guidance, explanation and destination/header names (values hidden) on stderr. A regular TTY keeps that JSON behaviour by default. --summary or --json=summary wins over --json. Dry-run makes no requests. --out preserves the export behaviour described below.
|
|
83
|
+
|
|
84
|
+
Real runs print the summary on stdout, ending with Connected: and the dashboard or validated claim link (printed once), followed by one Next guidance line for manual reporting or hook status. Explicit --json puts the safe body on stdout and all summary/guidance on stderr. --quiet suppresses success chatter, but safety warnings always appear on stderr, including during dry runs. Accepted reports show the Connected line even if saving local config or installing the hook fails; warnings and errors follow the summary. Rejected or unreachable reports have no Connected line.
|
|
85
|
+
|
|
86
|
+
--summary (also --json=summary) prints only the summary plus one guidance line on stdout in dry and real runs, with warnings on stderr and no JSON. --out <file.json> (also --out=file.json) writes the exact JSON body plus newline instead of printing JSON; in dry runs stdout stays empty and the summary stays on stderr unless --summary is also used. It works for real runs too. The file must be new, end in .json, and resolve inside the project root with an existing parent directory; parent symlink escapes are refused. It uses exclusive creation and never overwrites files. Connector config filenames and package.json are reserved so later setup writes cannot replace the exported body. Invalid output paths exit 2, including scan, with an error on stderr.
|
|
87
|
+
Example (optional `truncated` appears only when the inventory exceeds 5000):
|
|
88
|
+
|
|
89
|
+
```json
|
|
90
|
+
{
|
|
91
|
+
"v": 1,
|
|
92
|
+
"name": "notes.example.com",
|
|
93
|
+
"url": "https://notes.example.com",
|
|
94
|
+
"environment": "production",
|
|
95
|
+
"lockfile": "package-lock.json",
|
|
96
|
+
"versions_source": "lockfile",
|
|
97
|
+
"source": "connector",
|
|
98
|
+
"packages": [{ "ecosystem": "npm", "name": "vite", "version": "6.0.0", "dev": true }],
|
|
99
|
+
"supabase": { "project_ref": "abcdefghijklmnopqrst", "host": "abcdefghijklmnopqrst.supabase.co", "key_kind": "anon", "key_fingerprint": "12ab34cd" }
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
- `v`: report format version.
|
|
104
|
+
- `name`: explicit or rc name, then URL host (first label for platform hosts), then package name, skipping template and key-like names; limited to 80 letters, digits, spaces, @ / . _ -; omitted when unknown.
|
|
105
|
+
- `url`: HTTP(S) origin and path only, without credentials, query or fragment; paths are kept only with up to eight safe ASCII segments of at most 40 characters, excluding sb_, svk_ and eyJ markers; key-like hostnames are rejected; omitted when unknown.
|
|
106
|
+
- `platform`: detected project builder/hosting label; omitted when unknown.
|
|
107
|
+
- `environment`: `SAFETYVIBE_ENV`, or production when `NODE_ENV=production`; limited to 20 letters, digits, underscores or hyphens; omitted when unknown.
|
|
108
|
+
- `lockfile`: selected lockfile filename, or `none` when no readable lockfile exists. Parent locks are used only at workspace roots when the project matches a workspace glob in package.json workspaces (array or workspaces.packages) or the pnpm-workspace.yaml packages list. Literal paths, * and ** are supported; negated globs exclude matching paths from membership. Search stops at .git or six parent levels.
|
|
109
|
+
- `packages`: registry package names and versions, npm ecosystem, and optional `dev: true` for dev-only dependencies when recorded in the lockfile. Workspace links are excluded. Optional registry packages for all platforms are retained: this is a lockfile inventory, not a list of locally installed binaries. Source exclusions apply to each installation path or dependency edge, never to every package sharing a name. Recognized empty or fully excluded locks remain authoritative. Supported formats are npm v1/v2/v3, Yarn v1/Berry, pnpm v5.4/v6/v9 and text bun.lock; installed node_modules folders are never read. Without a readable lockfile (none, only binary bun.lockb, or an unparseable one), safe package.json registry ranges are used locally with `lockfile` set to `none` and `versions_source` set to `declared`. The CLI prints: "No readable lockfile found (package-lock.json, pnpm-lock.yaml, yarn.lock or bun.lock); using safe package.json declarations, not resolved versions." Network reports of declared inventories are blocked pending separately verified receiver support. For bun.lockb run `bun install --save-text-lockfile` to create bun.lock.
|
|
110
|
+
All supported lock parsers use one shared source classifier. An installation is excluded only when its declaration or lock protocol positively identifies a non-registry source (git+, git:, git@, ssh:, github:, gitlab:, bitbucket:, file:, link:, portal:, workspace:, exec:, a Git shorthand declaration, or an explicit HTTP(S) URL dependency), or its resolution identifies a known source-host archive: github.com/codeload.github.com archives or tarballs, raw.githubusercontent.com, gist, gitlab.com /-/archive/, or bitbucket.org /get/. A patch of a registry package remains that registry package. Every other valid semver row retains the lockfile name (or alias target/name field) and exact version. Private registry delivery paths and filenames are not validated, including Artifactory, Nexus, Verdaccio, GitLab, FontAwesome and CodeArtifact; renamed artifacts, version directories, archive/tarball/zipball names and /repository/archive/ mirrors are retained. Only registry.npmjs.org, registry.yarnpkg.com and npm.pkg.github.com (including their absolute DNS names with a final dot) require HTTP(S) canonical routes matching the row's full name and version: /name/-/name-version.tgz, scoped equivalents, or GitHub Packages /download/(@scope/)?name/version/hex. Other paths on those three hosts, malformed/mismatched encoded names or versions there, missing/invalid registry versions, unparseable resolution URLs, and other malformed or screened metadata make the inventory incomplete. pnpm registry-prefixed paths retain the package identity; peer suffixes are removed without changing prerelease or build metadata. Older pnpm URL-tarball keys use their recorded name/version and matching tarball or importer declaration to identify a URL source. An npm installation satisfying a source edge remains excluded even when a registry range also reaches it; unmatched source edges do not override a registry edge. HTTP registry URLs are accepted only under the same canonical route checks; inventory parsing does not fetch them. Each parsed installation is reported, positively excluded with a local reason, or marks the inventory incomplete; local classification diagnostics never enter the report JSON.
|
|
111
|
+
|
|
112
|
+
- `truncated`: optional boolean; only the first 5000 packages are sent. This limit is separate from malformed/screened-row incompleteness.
|
|
113
|
+
- `incomplete`: optional local-only boolean, present as `true` when detected malformed or screened registry rows prevent a complete inventory. Real setup/scan refuse this body; local previews and explicit exports retain it.
|
|
114
|
+
- `versions_source`: `lockfile` for resolved inventory; `declared` for safe manifest ranges in local inventory/dry-run output.
|
|
115
|
+
- `source`: always `connector`.
|
|
116
|
+
- `supabase`: null unless a validated URL and public key are found, or a client-exposed secret is detected. Public keys yield only `project_ref`, `host`, `key_kind` (`anon` or `publishable`) and `key_fingerprint` (first eight lowercase hex characters of SHA-256 of the UTF-8 key). `host` is the URL host only; `project_ref` is the lowercase 20-character alphanumeric ref of a .supabase.co host, otherwise null. An exposed secret always wins: only `{ "project_ref": null, "host": null, "secret_key_exposed_client_side": true }` is sent, with project_ref/host filled when a validated URL is known. No key kind, fingerprint or length is sent for secrets.
|
|
117
|
+
|
|
118
|
+
Nested fields: `packages[].ecosystem` is `npm`; `packages[].name` is the registry name; `packages[].version` is the exact lockfile version, or the unchanged safe declared registry range when versions_source is declared; optional `packages[].dev` is true for dev-only packages. `supabase.project_ref` identifies the project (or null); `supabase.host` is the validated host (or null); `supabase.key_kind` is anon or publishable; `supabase.key_fingerprint` is the eight-character SHA-256 prefix; `supabase.secret_key_exposed_client_side` is true only for a detected client-exposed secret and replaces kind/fingerprint.
|
|
119
|
+
|
|
120
|
+
Report metadata strings are screened before sending or printing: recognized key-like values (including encoded and Unicode-disguised forms) are dropped, with a local warning naming only the field. Known npm, GitHub and provider-token shapes are screened before the package-name exemption. A recognized key-like URL is dropped entirely. Arbitrary secrets without a recognized shape can evade screening; keep credentials out of package names, versions and labels, and review the local report. Authentication credentials are handled separately in the headers below.
|
|
121
|
+
|
|
122
|
+
The JSON body excludes source/file contents, file paths, full lockfiles, .env files and raw Supabase keys (including anon/publishable). App URLs omit credentials, query strings and fragments. These structural exclusions and known-shape screening do not guarantee that arbitrary metadata contains no secret.
|
|
123
|
+
The request headers x-safetyvibe-site, x-safetyvibe-key and x-safetyvibe-claim-token carry the validated UUID site ID, validated report key and validated one-shot claim token when available; these are not in the JSON body. The server validates public keys too for older clients; this connector sends no Supabase keys.
|
|
124
|
+
Public keys are read only from client-exposed variables (prefixes VITE_, NEXT_PUBLIC_, EXPO_PUBLIC_, PUBLIC_, REACT_APP_, NUXT_PUBLIC_; from the environment or .env files) or a client-side Supabase source file (src/integrations/supabase/client.*, src/lib/supabase.*, lib/supabase.ts, utils/supabase.ts). Files that contain the quoted text server-only or use server anywhere (even in a comment), are named *.server.*, or sit under server/, api/, app/api/, pages/api/, functions/, supabase/functions/, netlify/functions/ or are middleware.* are skipped. Server-only names such as SUPABASE_URL or SUPABASE_ANON_KEY are not selected as connection details. Every client-prefixed variable in process env and .env/.env.local/.env.production/.env.production.local is checked for exposed secrets, as are full secret-shaped runs in the scanned client files, independent of quote pairing (a stray apostrophe in a comment cannot hide a full secret), including full-secret comparisons and validation calls, while ignoring bare prefixes. Full secret shapes embedded in larger client values also set the flag. A key split across concatenated strings is not detected. Any service-role variable name in a .env* file, including SUPABASE_SERVICE_ROLE_KEY and SUPABASE_SERVICE_KEY, produces a separate local warning; its presence alone never sets an exposure flag or adds anything to the body. Local warnings name only the variable or relative client file, never the value, and tell you to rotate exposed secrets in Supabase.
|
|
125
|
+
|
|
126
|
+
Review the entire implementation in `cli.mjs` and `lib.mjs`. There are no dependencies and no install scripts in this package itself.
|
|
127
|
+
By default reports go only to `https://dashboard.safetyvibe.eu/connect/api/v1/report`. The committed rc cannot change the destination.
|
|
128
|
+
An explicit `SAFETYVIBE_API` environment override supports HTTPS, or HTTP on localhost/127.0.0.1/[::1] for local testing. Redirects are refused.
|
|
129
|
+
|
|
130
|
+
## Changes
|
|
131
|
+
|
|
132
|
+
0.3.3 (2026-10-29) retains locked dist-tag dependencies and reports Yarn npm aliases by their registry identity, including scoped targets. Detected malformed or screened registry rows mark local previews `incomplete: true` with warnings; real reporting refuses them. Known provider tokens are screened before package-name exemptions. Credential persistence verifies effective Git ignoring and warns on tracked files. Project reads reject symlink/junction escapes, and config writes reject linked targets.
|
|
133
|
+
|
|
134
|
+
0.3.2 (2026-10-19) adds the local `inventory` command, `--project` selection and bounded hints for common subprojects and npm/pnpm workspaces. Summaries distinguish direct declarations from total lockfile rows and show direct dev and confirmed dev-only counts; Yarn v1 resolves direct dev selectors without labelling runtime-shared or unknown transitive rows dev-only. `--json --compact` emits one-line full JSON; `--json=summary` selects the summary with explicit flag precedence. Without a usable lockfile, safe manifest ranges are preserved as `versions_source:"declared"` for local review; real declared reports remain blocked pending dashboard verification. Client-source secret scanning now uses a bounded forward pass and detects full secrets embedded in larger values, comparisons, validation calls and comments while ignoring bare prefixes. Recognized automation hints select summary output, which includes a Next guidance line.
|
|
135
|
+
|
|
136
|
+
0.3.1 fixes false secret alarms from Supabase prefix checks while keeping real secret warnings and public fingerprints. Non-TTY and automation/CI runs default to a five-line summary; --json opts into the body. It checks config writability before sending, stops re-sending env claim tokens for linked projects, warns locally about service-role variable names, and exits 2 for bad --out paths even on scan. It adds local source-review guidance.
|
|
137
|
+
|
|
138
|
+
0.3.0 removes raw Supabase keys from the report body: it reports public-key fingerprints or exposed-secret flags, puts a five-line summary first, adds --summary and safe --out JSON export, and ships MIT licensing and security contact details. 0.2.2 improves response deadlines, registry-only inventory, project selection and app labels, restores flag-only setup, and rejects ambiguous JWT payloads. It reads pnpm v5.4 locks and no longer reads installed node_modules folders: without a readable lockfile no packages are sent. 0.2.1 fixed a bug where a key on a commented .env line could be included; upgrade from 0.2.0.
|
|
139
|
+
|
|
140
|
+
[Documentation](https://safetyvibe.eu/connect) and [changelog / what is sent](https://safetyvibe.eu/connect/changelog).
|
|
141
|
+
|
|
142
|
+
## Files written and removal
|
|
143
|
+
|
|
144
|
+
Before a setup/scan request that can update connection settings or credentials, the connector probes directory writability and checks existing config files; a failure sends nothing and exits 1 for setup (0 for scan). For those runs, the credential file must be untracked and effectively ignored before reporting; verification failures send nothing. The ignore rule may be prepared even when the request fails or the receiver returns no key. Legacy credentials are then migrated into the local file, the committed api field is dropped and its URL normalized; a refused migration sends nothing. Dry-run writes only an explicitly requested --out file; status and help never write. After a successful report:
|
|
145
|
+
|
|
146
|
+
- `.safetyviberc.json`: app ID, normalized public URL, optional name and `hook: false`.
|
|
147
|
+
- `.safetyviberc.local.json`: report key and optional fallback claim token; never commit this file. The token is removed once used or rejected as expired/used. Once a valid site ID and report key are present, SAFETYVIBE_CLAIM_TOKEN is not re-sent. Only stored credentials require the local file. The ignore entry is prepared before reporting because the receiver may issue a key. Before reporting and again before saving credentials, Git check-ignore --no-index verifies effective ignoring, including later negations; a final anchored /.safetyviberc.local.json rule is added when needed and checked again. Git calls have bounded time/output, use no shell, and set LC_ALL=C and LANGUAGE=C so diagnostics can be interpreted consistently. Git ls-files detects an already tracked local file: setup warns, instructs git rm --cached -- .safetyviberc.local.json and rotation of previously committed credentials, and exits 1. It does not untrack files automatically. Only exit status 1 without an execution error or signal means the local file is untracked. A tracked file, timeout, signal, spawn error or unexpected Git status prevents credential and link-setting writes and makes setup fail with a warning. An absent Git binary (ENOENT) is treated as an unversioned project, so setup can save credentials and add the anchored ignore rule for future Git use. A genuinely unversioned project gets that rule too. Credentials that are saved use mode 0600. An ineffective ignore rule still warns and fails setup even when the file was confirmed untracked. Persistence checks are repeated after acceptance to catch local changes. If saving is then refused, recovery guidance includes the site ID, never the key; Connected does not prove local credential safety. Scan keeps exit 0 for install hooks. Empty local credentials are removed.
|
|
148
|
+
- `.gitignore`: ensures an effective rule for the local config filename as described above.
|
|
149
|
+
- `package.json`: setup normally adds a postinstall report hook. `--no-hook` leaves package.json untouched and persists this preference. Existing unsafe shell scripts are left untouched with a manual instruction.
|
|
150
|
+
|
|
151
|
+
The project directory is cwd. INIT_CWD is used only when its own package.json lists the connector or its postinstall hook and it is not a workspace root. Scan at an npm/Yarn workspace root (package.json workspaces) or pnpm workspace root (pnpm-workspace.yaml with a packages list) that has no app ID in .safetyviberc.json is skipped without network or writes; run setup in the app directory. A root that was linked by running setup there is treated like any app: it reports and updates its rc files. Dry-run still previews the selected directory. An unlinked scan without a key or claim token skips projects without the connector dependency. Requests have one deadline of at most 10 seconds, including the response body, capped at 64 KiB. Failed responses keep the token unless the server reports it expired or already used, and do not install a hook.
|
|
152
|
+
|
|
153
|
+
An already-linked scan using only SAFETYVIBE_KEY, with no stored key/claim token, config migration, URL/name change or hook-preference change, skips Git/write preflight and leaves connection settings and credentials untouched. A key returned by the receiver is not saved in this mode. This allows env-keyed scans in read-only CI checkouts even when Git ownership verification fails. Project read/link boundaries and inventory refusal guards still apply; explicit --out remains an opt-in JSON export.
|
|
154
|
+
|
|
155
|
+
The postinstall hook runs `safetyvibe-connect scan --quiet || exit 0`: it re-sends the current inventory and public Supabase details using the local report key, suppresses success chatter but keeps safety warnings on stderr, and never fails installation. Without a local key it skips reporting for a linked app unless SAFETYVIBE_KEY or a claim token is supplied.
|
|
156
|
+
|
|
157
|
+
Without terminal access, first verify `.safetyviberc.local.json` is untracked and effectively ignored (including later negations); rule text alone is insufficient. Then write `{"claimToken": "<TOKEN>"}` into `.safetyviberc.local.json` and configure the dependency and postinstall hook. Never put the token in the committed `.safetyviberc.json`.
|
|
158
|
+
|
|
159
|
+
For manual reporting use `npx -y safetyvibe-connect@0.3.3 scan` (pnpm: `pnpm dlx`, bun: `bunx`, yarn: `yarn dlx`).
|
|
160
|
+
Remove the connector dependency if installed, its postinstall command, both rc files, and the local-config .gitignore entry. Keep other postinstall commands.
|
|
161
|
+
|
|
162
|
+
## Commands
|
|
163
|
+
|
|
164
|
+
| Command | Effect |
|
|
165
|
+
|---|---|
|
|
166
|
+
| `setup [--claim-token T] [--url URL] [--name NAME] [--no-hook]` | Send report, save config, optionally add hook |
|
|
167
|
+
| `setup --dry-run` or `--dry-run` | Preview summary (--json for the body) without network; only --out writes a file |
|
|
168
|
+
| `inventory [--project DIR] [--json] [--compact]` | Local review body/summary; no network or config writes, only explicit --out writes |
|
|
169
|
+
| `scan [--quiet]` | Re-report; exits 0 for install hooks, except bad --out exits 2 |
|
|
170
|
+
| `status` | Show local link state |
|
|
171
|
+
| `help`, `--help`, `-h`, no arguments | Usage only |
|
|
172
|
+
| `--version`, `-v` | Package version only |
|
|
173
|
+
|
|
174
|
+
Flags without a command imply setup. Unknown name, URL, platform and environment fields are omitted, never empty strings.
|
|
175
|
+
|
|
176
|
+
Value flags accept `--flag=value` or `--flag value`, including values starting with a dash. In the space form, a known flag (also with `=...`) is treated as a missing value. Unknown commands/flags and missing values exit 2, except scan exits 0 (a missing --out value still exits 2).
|