@gscdump/cli 0.8.0 → 0.8.2

package/README.md

@@ -40,22 +40,54 @@ gscdump mcp
 
 | Command | Description |
 |---|---|
-| `init` | Set up GSCDump authentication |
-| `auth` | Manage authentication (`status`, `logout`) |
-| `config` | Manage CLI configuration (`show`, `set`, `unset`, `path`) |
-| `sites` | List available GSC sites |
-| `sitemaps` | List/manage sitemaps for a site |
-| `inspect` | Inspect a URL's indexing status |
-| `sync` | Sync GSC data to the local Parquet store |
-| `query` | Run a search analytics query (local store by default; `--live` hits GSC API) |
-| `dump` | Export live Parquet files from the store to a directory |
+| `init` | Full setup (OAuth + dataDir; offers to write a `.env` for portability) |
+| `auth` | Manage authentication (`status`, `login`, `logout`, `refresh`) |
+| `config` | Manage CLI configuration (`show`, `set`, `unset`, `path`, `validate`) |
+| `doctor` | Health checks: auth, scopes, dataDir writability, API reachability |
+| `sites [--owner-only] [--with-sitemaps]` | List available GSC sites |
+| `sites add <url>` / `sites delete <url> [--yes]` | Register / remove a property in Search Console (add registers in unverified state) |
+| `sites verify-token <url> [--method]` / `sites verify <url> [--method]` | Get a verification token, then trigger ownership verification (META/FILE/DNS_TXT/DNS_CNAME/ANALYTICS/TAG_MANAGER) |
+| `sitemaps` | Sitemap CRUD (`list [--pending] [--errored]`, `get`, `submit`, `delete`) |
+| `inspect <url>` / `inspect batch [--concurrency]` | URL inspection (single URL or batch from file/stdin); renders index status, rich results, AMP, mobile usability |
+| `indexing` | Notify Google about URL changes (`submit`, `remove`, `status`, `batch [--concurrency] [--yes]`); supports `--retries` |
+| `sync` | Sync GSC data to the local Parquet store; `--retry-failed`, `--dry-run` |
+| `query` | Run a search analytics query (local store by default; `--live` hits GSC API). Filters: `--query`, `--page`, `--country`, `--device`, `--search-appearance`, `--type`, `--data-state`, `--aggregation-type`. `--explain` previews the request body; `--output -` writes to stdout. |
+| `dump` | Export from the store to a directory (`--format parquet\|json\|ndjson\|csv`, `--tables`, `--all-sites`) |
 | `analyze <tool>` | Run an SEO analyzer against the store (`--live` for row-based against fresh API) |
+| `entities` | Snapshot URL inspections / sitemaps / indexing metadata into the local entity store |
 | `store stats` | Show row/byte counts per table and on-disk footprint |
-| `store compact` | Roll daily partitions older than N days into monthly files |
-| `store gc` | Delete orphaned objects past the grace window |
-| `store export` | Export raw Parquet files |
+| `store compact` | Roll daily partitions older than N days into monthly files (`--dry-run`) |
+| `store gc` | Delete orphaned objects past the grace window (`--dry-run`) |
+| `store export` | Export the live store to a single `.duckdb` file |
+| `store rollups rebuild` | Rebuild post-sync rollup tables |
 | `mcp` | Start the MCP server for AI assistants |
 
+### Filter expressions
+
+`query` accepts prefix-encoded filter expressions for `--query`, `--page`, `--country`, `--device`, `--search-appearance`:
+
+| Prefix | Operator |
+|---|---|
+| (bare) | equals |
+| `~foo` | contains |
+| `!~foo` | not contains |
+| `re:foo` | regex |
+| `!re:foo` | not regex |
+| `!foo` | not equals |
+
+```bash
+# pages under /blog/ with brand mentions in the query
+gscdump query --live --site sc-domain:example.com \
+  --page '~/blog/' --query '~brand' --dimensions page,query
+```
+
+### Global flags
+
+- `--no-color` / `NO_COLOR` env: strip ANSI from stdout (stderr keeps colour for interactive use).
+- `--config-dir <path>` / `GSCDUMP_CONFIG_DIR`: override `~/.config/gscdump`.
+- `--profile <name>` / `GSCDUMP_PROFILE`: scope tokens + config to a profile under `~/.config/gscdump/profiles/<name>` (juggle multiple GSC accounts).
+- Most commands accept `--quiet` and `--json` for scripted use; `logger` writes to stderr so `--json` output is safe to pipe.
+
 ## Analyzers
 
 `gscdump analyze <tool>` dispatches to `@gscdump/analysis`. 21 tools available:
@@ -119,14 +151,49 @@ Then ask questions like:
 
 ## Auth
 
-`gscdump init` walks you through OAuth2 with Google. Credentials are stored locally under `~/.config/gscdump/` (XDG) or equivalent.
+`gscdump init` walks you through full setup (OAuth + data dir). Credentials are stored locally under `~/.config/gscdump/` (XDG) or equivalent. Use `gscdump auth login` if you only want to refresh OAuth tokens without touching config.
 
 For manual setup:
 
 1. Create a Google Cloud project.
 2. Enable **Search Console API** and **Web Search Indexing API**.
 3. Create OAuth2 credentials (Desktop app).
-4. Run `gscdump init`.
+4. Run `gscdump init` (or `gscdump auth login`).
+
+### BYOK (Bring Your Own Key)
+
+Skip `init` entirely by setting env vars. Either path works (`GSC_*` preferred, `GOOGLE_*` accepted):
+
+```bash
+# Option A: raw bearer token (e.g., from gcloud or another OAuth flow)
+export GSC_ACCESS_TOKEN=ya29...
+
+# Option B: refresh-token flow (no google-auth-library dep used)
+export GSC_CLIENT_ID=...
+export GSC_CLIENT_SECRET=...
+export GSC_REFRESH_TOKEN=...
+```
+
+When BYOK is detected, `gscdump auth status` reports `byok` as the source and `gscdump auth login` is a no-op.
+
+### Service account
+
+For CI / headless usage, point `gscdump` at a service-account JSON key. The service account must be granted access to each property in Search Console (Settings → Users and permissions).
+
+```bash
+gscdump auth login --service-account ./gsc-sa.json   # smoke-test the key
+export GOOGLE_APPLICATION_CREDENTIALS=$(realpath ./gsc-sa.json)
+gscdump sites
+```
+
+### Headless OAuth
+
+When the loopback flow can't open a browser (servers, containers, WSL2 without forwarding), use the device-code flow:
+
+```bash
+gscdump auth login --no-browser
+# → opens a verification URL on any device; type the displayed user code
+```
 
 ## Related
 

package/dist/THIRD-PARTY-LICENSES.md

@@ -0,0 +1,155 @@
+# Licenses of Bundled Dependencies
+
+The published artifact additionally contains code with the following licenses:
+MIT
+
+# Bundled Dependencies
+
+## destr, ofetch, ufo
+
+License: MIT
+Repositories: https://github.com/unjs/destr, https://github.com/unjs/ofetch, https://github.com/unjs/ufo
+
+> MIT License
+> 
+> Copyright (c) Pooya Parsa <pooya@pi0.io>
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.
+
+---------------------------------------
+
+## node-fetch-native
+
+License: MIT
+Repository: https://github.com/unjs/node-fetch-native
+
+> MIT License
+> 
+> Copyright (c) Pooya Parsa <pooya@pi0.io>
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.
+> 
+> ---
+> 
+> https://github.com/node-fetch/node-fetch
+> 
+> The MIT License (MIT)
+> 
+> Copyright (c) 2016 - 2020 Node Fetch Team
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+> 
+> ---
+> 
+> https://github.com/mysticatea/abort-controller
+> 
+> MIT License
+> 
+> Copyright (c) 2017 Toru Nagashima
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.
+> 
+> ---
+> 
+> https://github.com/TooTallNate/proxy-agents
+> 
+> (The MIT License)
+> 
+> Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
+> 
+> Permission is hereby granted, free of charge, to any person obtaining
+> a copy of this software and associated documentation files (the
+> 'Software'), to deal in the Software without restriction, including
+> without limitation the rights to use, copy, modify, merge, publish,
+> distribute, sublicense, and/or sell copies of the Software, and to
+> permit persons to whom the Software is furnished to do so, subject to
+> the following conditions:
+> 
+> The above copyright notice and this permission notice shall be
+> included in all copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+> IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+> CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+> TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+> 
+> ---
+> 
+> https://github.com/nodejs/undici
+> 
+> MIT License
+> 
+> Copyright (c) Matteo Collina and Undici contributors
+> 
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+> 
+> The above copyright notice and this permission notice shall be included in all
+> copies or substantial portions of the Software.
+> 
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.

package/dist/_chunks/config.mjs

@@ -0,0 +1,45 @@
+import { t as __exportAll } from "./rolldown-runtime.mjs";
+import fs from "node:fs/promises";
+import path from "node:path";
+import os from "node:os";
+var config_exports = /* @__PURE__ */ __exportAll({
+	defaultDataDir: () => defaultDataDir,
+	getConfigDir: () => getConfigDir,
+	getConfigPath: () => getConfigPath,
+	loadConfig: () => loadConfig,
+	resolveDataDir: () => resolveDataDir,
+	saveConfig: () => saveConfig,
+	setConfigDir: () => setConfigDir
+});
+let configDir = path.join(os.homedir(), ".config", "gscdump");
+function setConfigDir(dir) {
+	configDir = dir;
+}
+function getConfigDir() {
+	return configDir;
+}
+function defaultDataDir() {
+	return path.join(os.homedir(), ".gscdump", "data");
+}
+function resolveDataDir(config) {
+	return expandTilde(config.dataDir ?? defaultDataDir());
+}
+function expandTilde(p) {
+	if (p === "~") return os.homedir();
+	if (p.startsWith("~/")) return path.join(os.homedir(), p.slice(2));
+	return p;
+}
+async function loadConfig() {
+	return fs.readFile(path.join(configDir, "config.json"), "utf-8").then((data) => JSON.parse(data)).catch(() => ({}));
+}
+async function saveConfig(config) {
+	await fs.mkdir(configDir, {
+		recursive: true,
+		mode: 448
+	});
+	await fs.writeFile(path.join(configDir, "config.json"), JSON.stringify(config, null, 2), { mode: 384 });
+}
+function getConfigPath() {
+	return path.join(configDir, "config.json");
+}
+export { loadConfig as a, setConfigDir as c, getConfigPath as i, defaultDataDir as n, resolveDataDir as o, getConfigDir as r, saveConfig as s, config_exports as t };

package/dist/_chunks/libs/destr.mjs

@@ -0,0 +1,42 @@
+const suspectProtoRx = /"(?:_|\\u0{2}5[Ff]){2}(?:p|\\u0{2}70)(?:r|\\u0{2}72)(?:o|\\u0{2}6[Ff])(?:t|\\u0{2}74)(?:o|\\u0{2}6[Ff])(?:_|\\u0{2}5[Ff]){2}"\s*:/;
+const suspectConstructorRx = /"(?:c|\\u0063)(?:o|\\u006[Ff])(?:n|\\u006[Ee])(?:s|\\u0073)(?:t|\\u0074)(?:r|\\u0072)(?:u|\\u0075)(?:c|\\u0063)(?:t|\\u0074)(?:o|\\u006[Ff])(?:r|\\u0072)"\s*:/;
+const JsonSigRx = /^\s*["[{]|^\s*-?\d{1,16}(\.\d{1,17})?([Ee][+-]?\d+)?\s*$/;
+function jsonParseTransform(key, value) {
+	if (key === "__proto__" || key === "constructor" && value && typeof value === "object" && "prototype" in value) {
+		warnKeyDropped(key);
+		return;
+	}
+	return value;
+}
+function warnKeyDropped(key) {
+	console.warn(`[destr] Dropping "${key}" key to prevent prototype pollution.`);
+}
+function destr(value, options = {}) {
+	if (typeof value !== "string") return value;
+	if (value[0] === "\"" && value[value.length - 1] === "\"" && value.indexOf("\\") === -1) return value.slice(1, -1);
+	const _value = value.trim();
+	if (_value.length <= 9) switch (_value.toLowerCase()) {
+		case "true": return true;
+		case "false": return false;
+		case "undefined": return;
+		case "null": return null;
+		case "nan": return NaN;
+		case "infinity": return Number.POSITIVE_INFINITY;
+		case "-infinity": return Number.NEGATIVE_INFINITY;
+	}
+	if (!JsonSigRx.test(value)) {
+		if (options.strict) throw new SyntaxError("[destr] Invalid JSON");
+		return value;
+	}
+	try {
+		if (suspectProtoRx.test(value) || suspectConstructorRx.test(value)) {
+			if (options.strict) throw new Error("[destr] Possible prototype pollution");
+			return JSON.parse(value, jsonParseTransform);
+		}
+		return JSON.parse(value);
+	} catch (error) {
+		if (options.strict) throw error;
+		return value;
+	}
+}
+export { destr as t };