@gscdump/devframe 5.7.0 → 5.7.1

package/dist/client/index.html

@@ -4,8 +4,8 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Search Console</title>
-    <script type="module" crossorigin src="./assets/index-B8m88k2l.js"></script>
-    <link rel="stylesheet" crossorigin href="./assets/index-Bv6TqI10.css">
+    <script type="module" crossorigin src="./assets/index-DA7Lgn7_.js"></script>
+    <link rel="stylesheet" crossorigin href="./assets/index-BdO8MoYt.css">
   </head>
   <body>
     <div id="app"></div>

package/dist/index.d.mts

@@ -1,7 +1,9 @@
 import { DailyPoint, DateWindow, GscdumpContext, MetricTotals, PageStats, PageStatsInput, Period, QueryRow, SiteSummary } from "./shared/protocol.mjs";
-import { GscdumpReaderOptions } from "./reader.mjs";
+import { HostedSourceOptions } from "./sources/hosted.mjs";
 import { DevframeDefinition } from "devframe";
-export interface GscdumpDevframeOptions extends GscdumpReaderOptions {
+export interface GscdumpDevframeOptions extends HostedSourceOptions {
+  /** The Site to read: a Site ID, a Site URL, or its host. Optional when the credential holds one Site. */
+  site?: string;
   /** Override the request implementation, for proxies and tests. */
   fetch?: typeof fetch;
 }
@@ -13,4 +15,4 @@ export interface GscdumpDevframeOptions extends GscdumpReaderOptions {
  * devframe hub.
  */
 export declare function createGscdumpDevframe(options?: GscdumpDevframeOptions): DevframeDefinition;
-export { type DailyPoint, type DateWindow, type GscdumpContext, type GscdumpReaderOptions, type MetricTotals, type PageStats, type PageStatsInput, type Period, type QueryRow, type SiteSummary, createGscdumpDevframe as default };
+export { type DailyPoint, type DateWindow, type GscdumpContext, type HostedSourceOptions, type MetricTotals, type PageStats, type PageStatsInput, type Period, type QueryRow, type SiteSummary, createGscdumpDevframe as default };

package/dist/index.mjs

@@ -1,7 +1,8 @@
 import { description, homepage, name, version } from "./package.mjs";
 import { DEVFRAME_ID } from "./shared/protocol.mjs";
-import { createGscdumpReader } from "./reader.mjs";
+import { createPageStatsReader } from "./reader.mjs";
 import { createRpcFunctions } from "./rpc.mjs";
+import { createHostedSource } from "./sources/hosted.mjs";
 import { createRequire } from "node:module";
 import { readFile } from "node:fs/promises";
 import { homedir } from "node:os";
@@ -38,12 +39,12 @@ function createGscdumpDevframe(options = {}) {
 		capabilities: { build: false },
 		setup(ctx) {
 			const env = process.env;
-			const reader = createGscdumpReader(options, {
+			const source = createHostedSource(options, {
 				fetch: options.fetch ?? globalThis.fetch,
 				env,
-				readCliAuthentication: () => readCliAuthentication(env),
-				now: Date.now
+				readCliAuthentication: () => readCliAuthentication(env)
 			});
+			const reader = createPageStatsReader({ site: options.site }, source, Date.now);
 			const scoped = ctx.scope(DEVFRAME_ID);
 			for (const fn of createRpcFunctions(reader)) scoped.rpc.register(fn);
 		}

package/dist/package.mjs

@@ -1,5 +1,5 @@
 var name = "@gscdump/devframe";
-var version = "5.7.0";
+var version = "5.7.1";
 var description = "Search Console clicks, impressions, and queries for the page you are developing, in Vite DevTools and any devframe hub.";
 var homepage = "https://github.com/harlan-zw/gscdump/tree/main/packages/devframe#readme";
 export { description, homepage, name, version };

package/dist/reader.mjs

@@ -1,190 +1,172 @@
-import { bearerOf, dashboardOrigin, resolveCredential } from "./credential.mjs";
-import { matchSite, readAccount } from "./account.mjs";
+import { hostOf } from "./source.mjs";
+import { matchSite } from "./account.mjs";
 import { addDays, dashboardPageUrl, pagePathOf, parseQueryRows, periodWindows, summariseDaily } from "./page-stats.mjs";
 import { PERIODS } from "./shared/protocol.mjs";
-import { parseRecordReadRefusal } from "@gscdump/contracts";
 import { periodToDateRange } from "@gscdump/sdk/period";
-import { createGscdumpV1Client, isGscdumpV1Error } from "@gscdump/sdk/v1";
-const ACCOUNT_TTL_MS = 3e5;
+const SITES_TTL_MS = 3e5;
 const STATS_TTL_MS = 3e5;
 const TOP_QUERIES = 25;
-function rowsBody(dimension, path, window) {
-	return {
-		dimensions: [dimension],
-		filter: { _filters: [{
-			dimension: "date",
-			operator: "between",
-			expression: window.start,
-			expression2: window.end
-		}, {
-			dimension: "page",
-			operator: "equals",
-			expression: path
-		}] },
-		orderBy: dimension === "date" ? {
-			column: "date",
-			dir: "asc"
-		} : {
-			column: "clicks",
-			dir: "desc"
-		},
-		rowLimit: dimension === "date" ? 400 : TOP_QUERIES
-	};
-}
 function periodDays(period) {
 	return PERIODS.find((option) => option.value === period)?.days ?? 28;
 }
-function createGscdumpReader(options, deps) {
-	let session = null;
+function contextForPage(sites, pageUrl, preferredSiteId) {
+	const host = hostOf(pageUrl) ?? pageUrl;
+	const matches = sites.filter((site) => site.host === host);
+	if (matches.length === 0) return {
+		_tag: "NoSiteForPage",
+		host
+	};
+	const pick = matches.find((site) => site.siteId === preferredSiteId) ?? (matches.length === 1 ? matches[0] : void 0);
+	return pick ? {
+		_tag: "Ready",
+		site: pick,
+		sites: matches,
+		configured: false
+	} : {
+		_tag: "SiteRequired",
+		sites: matches,
+		target: host
+	};
+}
+function createPageStatsReader(options, source, now) {
+	let sitesCache = null;
 	const stats = /* @__PURE__ */ new Map();
-	async function loadSession() {
-		const credential = await resolveCredential({
-			apiKey: options.apiKey,
-			apiRoot: options.apiRoot,
-			env: deps.env,
-			readCliAuthentication: deps.readCliAuthentication
-		});
-		if (!credential) return {
-			_tag: "Blocked",
-			context: { _tag: "CredentialMissing" }
-		};
-		const account = await readAccount(credential, deps.fetch);
-		if (account._tag === "Rejected") return {
-			_tag: "Blocked",
-			context: {
-				_tag: "CredentialRejected",
-				source: credential.source
-			}
-		};
-		if (account._tag === "Unavailable") return {
-			_tag: "Blocked",
-			context: {
-				_tag: "Unavailable",
-				message: account.message
-			}
-		};
-		if (account.sites.length === 0) return {
-			_tag: "Blocked",
-			context: { _tag: "NoSites" }
-		};
-		return {
-			_tag: "Ready",
-			credential,
-			client: createGscdumpV1Client({
-				apiRoot: credential.apiRoot,
-				credential: bearerOf(credential),
-				fetch: deps.fetch
-			}),
-			sites: account.sites
-		};
-	}
-	function currentSession() {
-		if (session && deps.now() - session.at < ACCOUNT_TTL_MS) return session.value;
-		const value = loadSession();
-		session = {
-			at: deps.now(),
+	function readSites() {
+		if (sitesCache && now() - sitesCache.at < SITES_TTL_MS) return sitesCache.value;
+		const value = source.sites();
+		sitesCache = {
+			at: now(),
 			value
 		};
 		value.then((result) => {
-			if (result._tag === "Blocked" && session?.value === value) session = null;
+			if (result._tag === "Blocked" && sitesCache?.value === value) sitesCache = null;
 		}, () => {
-			if (session?.value === value) session = null;
+			if (sitesCache?.value === value) sitesCache = null;
 		});
 		return value;
 	}
-	async function context(preferredSiteId) {
-		const current = await currentSession();
-		if (current._tag === "Blocked") return current.context;
+	async function context(preferredSiteId, pageUrl) {
+		const read = await readSites();
+		if (read._tag === "Blocked") return read.context;
+		const sites = read.sites;
+		if (sites.length === 0) return { _tag: "NoSites" };
 		if (options.site) {
-			const match = matchSite(current.sites, options.site);
-			return match._tag === "Found" ? {
+			const match = matchSite(sites, options.site);
+			if (match._tag === "Found") return {
 				_tag: "Ready",
 				site: match.site,
-				sites: current.sites,
+				sites,
 				configured: true
+			};
+			const picked = preferredSiteId ? sites.find((site) => site.siteId === preferredSiteId) : void 0;
+			return picked ? {
+				_tag: "Ready",
+				site: picked,
+				sites,
+				configured: false
 			} : {
 				_tag: "SiteRequired",
-				sites: current.sites,
+				sites,
 				target: options.site
 			};
 		}
-		const preferred = preferredSiteId ? current.sites.find((site) => site.siteId === preferredSiteId) : void 0;
+		if (options.siteFromPage && pageUrl) return contextForPage(sites, pageUrl, preferredSiteId ?? null);
+		const preferred = preferredSiteId ? sites.find((site) => site.siteId === preferredSiteId) : void 0;
 		if (preferred) return {
 			_tag: "Ready",
 			site: preferred,
-			sites: current.sites,
+			sites,
 			configured: false
 		};
-		const match = matchSite(current.sites, null);
+		const match = matchSite(sites, null);
 		return match._tag === "Found" ? {
 			_tag: "Ready",
 			site: match.site,
-			sites: current.sites,
+			sites,
 			configured: false
 		} : {
 			_tag: "SiteRequired",
-			sites: current.sites,
+			sites,
+			target: null
+		};
+	}
+	async function siteForPage(input) {
+		if (!options.siteFromPage) return context(input.siteId);
+		const read = await readSites();
+		if (read._tag === "Blocked") return read.context;
+		const chosen = input.siteId ? read.sites.find((site) => site.siteId === input.siteId) : void 0;
+		if (chosen) return {
+			_tag: "Ready",
+			site: chosen,
+			sites: read.sites,
+			configured: false
+		};
+		return /^https?:\/\//i.test(input.page) ? contextForPage(read.sites, input.page, null) : {
+			_tag: "SiteRequired",
+			sites: read.sites,
 			target: null
 		};
 	}
-	async function readRows(client, siteId, body) {
-		return (await client.queryAnalyticsRows({
-			params: { siteId },
-			body
-		})).data.rows;
+	function firstFailure(daily, queries) {
+		if (daily._tag !== "Ok") return daily;
+		return queries._tag !== "Ok" ? queries : null;
 	}
-	async function readPage(current, site, path, period, windows, retried) {
+	async function readPage(site, path, period, windows, retried) {
 		const span = {
 			start: windows.previous?.start ?? windows.current.start,
 			end: windows.current.end
 		};
-		const result = await Promise.all([readRows(current.client, site.siteId, rowsBody("date", path, span)), readRows(current.client, site.siteId, rowsBody("query", path, windows.current))]).catch((error) => error);
-		if (Array.isArray(result)) {
-			const [daily, queries] = result;
-			return {
-				_tag: "Ok",
-				siteId: site.siteId,
-				path,
-				period,
-				window: windows.current,
-				previousWindow: windows.previous,
-				...summariseDaily(daily, windows),
-				queries: parseQueryRows(queries),
-				dashboardUrl: dashboardPageUrl(dashboardOrigin(current.credential.apiRoot), site, path)
-			};
-		}
-		if (!isGscdumpV1Error(result)) throw result;
-		const refusal = parseRecordReadRefusal(result.details);
-		if (refusal?.reason === "range_not_synced" && !retried && refusal.missingStart > windows.current.start) {
-			const shifted = periodWindows(periodDays(period), {
-				oldestDate: site.oldestDate,
-				newestDate: addDays(refusal.missingStart, -1)
-			});
-			if (shifted) return readPage(current, site, path, period, shifted, true);
-		}
-		if (refusal?.reason === "record_not_ready") return {
-			_tag: "NoData",
+		const [daily, queries] = await Promise.all([source.dailyRows(site.siteId, path, span), source.queryRows(site.siteId, path, windows.current, TOP_QUERIES)]);
+		const failure = firstFailure(daily, queries);
+		if (!failure && daily._tag === "Ok" && queries._tag === "Ok") return {
+			_tag: "Ok",
 			siteId: site.siteId,
-			message: "gscdump has not prepared this Site's record for reads yet. Try again in a few minutes."
-		};
-		if (refusal?.reason === "range_not_synced") return {
-			_tag: "NoData",
-			siteId: site.siteId,
-			message: `The Site's record does not hold ${refusal.missingStart} to ${refusal.missingEnd} yet.`
-		};
-		if (result.code === "rate_limited") return { _tag: "RateLimited" };
-		if (result.status === 401 || result.status === 403) return {
-			_tag: "SiteUnavailable",
-			context: {
-				_tag: "CredentialRejected",
-				source: current.credential.source
+			path,
+			period,
+			window: windows.current,
+			previousWindow: windows.previous,
+			...summariseDaily(daily.rows, windows),
+			queries: parseQueryRows(queries.rows),
+			dashboardUrl: dashboardPageUrl(source.dashboardOrigin, site, path)
+		};
+		switch (failure?._tag) {
+			case "Refused": {
+				const refusal = failure.refusal;
+				if (refusal.reason === "range_not_synced" && !retried && refusal.missingStart > windows.current.start) {
+					const shifted = periodWindows(periodDays(period), {
+						oldestDate: site.oldestDate,
+						newestDate: addDays(refusal.missingStart, -1)
+					});
+					if (shifted) return readPage(site, path, period, shifted, true);
+				}
+				return refusal.reason === "record_not_ready" ? {
+					_tag: "NoData",
+					siteId: site.siteId,
+					message: "gscdump has not prepared this Site's record for reads yet. Try again in a few minutes."
+				} : {
+					_tag: "NoData",
+					siteId: site.siteId,
+					message: `The Site's record does not hold ${refusal.missingStart} to ${refusal.missingEnd} yet.`
+				};
 			}
-		};
-		return {
-			_tag: "Failed",
-			message: result.message,
-			requestId: result.requestId ?? null
-		};
+			case "RateLimited": return { _tag: "RateLimited" };
+			case "Unauthorized":
+				sitesCache = null;
+				return {
+					_tag: "SiteUnavailable",
+					context: failure.context
+				};
+			case "Failed": return {
+				_tag: "Failed",
+				message: failure.message,
+				requestId: failure.requestId
+			};
+			default: return {
+				_tag: "Failed",
+				message: "The read returned no rows and no error.",
+				requestId: null
+			};
+		}
 	}
 	async function pageStats(input) {
 		const path = pagePathOf(input.page);
@@ -193,7 +175,7 @@ function createGscdumpReader(options, deps) {
 			page: input.page
 		};
 		const period = input.period ?? "28d";
-		const resolved = await context(input.siteId);
+		const resolved = await siteForPage(input);
 		if (resolved._tag !== "Ready") return {
 			_tag: "SiteUnavailable",
 			context: resolved
@@ -201,13 +183,8 @@ function createGscdumpReader(options, deps) {
 		const site = resolved.site;
 		const key = `${site.siteId}|${period}|${path}`;
 		const hit = stats.get(key);
-		if (hit && deps.now() - hit.at < STATS_TTL_MS) return hit.value;
-		const current = await currentSession();
-		if (current._tag !== "Ready") return {
-			_tag: "SiteUnavailable",
-			context: current.context
-		};
-		const stableEnd = periodToDateRange(period, { now: new Date(deps.now()) }).end;
+		if (hit && now() - hit.at < STATS_TTL_MS) return hit.value;
+		const stableEnd = periodToDateRange(period, { now: new Date(now()) }).end;
 		const newestDate = site.newestDate && site.newestDate > stableEnd ? stableEnd : site.newestDate;
 		const windows = periodWindows(periodDays(period), {
 			oldestDate: site.oldestDate,
@@ -218,9 +195,9 @@ function createGscdumpReader(options, deps) {
 			siteId: site.siteId,
 			message: "The Site's record holds no days yet. gscdump is still syncing it."
 		};
-		const value = readPage(current, site, path, period, windows, false);
+		const value = readPage(site, path, period, windows, false);
 		stats.set(key, {
-			at: deps.now(),
+			at: now(),
 			value
 		});
 		value.then((result) => {
@@ -235,4 +212,4 @@ function createGscdumpReader(options, deps) {
 		pageStats
 	};
 }
-export { createGscdumpReader };
+export { createPageStatsReader };

package/dist/rpc.mjs

@@ -15,7 +15,7 @@ function createRpcFunctions(reader) {
 		name: "get-context",
 		type: "query",
 		jsonSerializable: true,
-		handler: (preferredSiteId) => reader.context(preferredSiteId ?? null)
+		handler: (preferredSiteId, pageUrl) => reader.context(preferredSiteId ?? null, pageUrl ?? null)
 	}), defineRpcFunction({
 		name: "get-page-stats",
 		type: "query",

package/dist/shared/protocol.d.mts

@@ -3,14 +3,16 @@ export interface SiteSummary {
   siteId: string;
   /** The Site as gscdump registered it, for example `example.com`. */
   siteUrl: string;
+  /** The exact host the Site covers, for example `example.com`. A page on another host is not on this Site. */
+  host: string;
   /** The first day the Hosted record holds, `YYYY-MM-DD`. */
   oldestDate: string | null;
   /** The last day the Hosted record holds, `YYYY-MM-DD`. */
   newestDate: string | null;
 }
 /**
- * What the node side can read, decided once per panel boot. Each tag names
- * the next step the panel shows.
+ * What the panel can read, decided once per panel boot and again when the
+ * page's host changes. Each tag names the next step the panel shows.
  */
 export type GscdumpContext = {
   _tag: 'Ready';
@@ -22,12 +24,20 @@ export type GscdumpContext = {
   sites: SiteSummary[];
   target: string | null;
 } | {
+  _tag: 'NoSiteForPage';
+  host: string;
+} | BlockedContext;
+/** A context that stops before any Site is chosen: no credential, no Sites, or no service. */
+export type BlockedContext = {
   _tag: 'NoSites';
 } | {
   _tag: 'CredentialMissing';
 } | {
   _tag: 'CredentialRejected';
   source: CredentialSource;
+} | {
+  _tag: 'SignedOut';
+  signInUrl: string;
 } | {
   _tag: 'Unavailable';
   message: string;

package/dist/source.d.mts

@@ -0,0 +1 @@
+import "./shared/protocol.mjs";

package/dist/source.mjs

@@ -0,0 +1,7 @@
+function hostOf(value) {
+	const text = value.trim();
+	if (text.startsWith("sc-domain:")) return text.slice(10).toLowerCase().replace(/\.$/, "") || null;
+	const url = URL.parse(/^[a-z][a-z\d+.-]*:\/\//i.test(text) ? text : `https://${text}`);
+	return url?.hostname ? url.hostname.toLowerCase() : null;
+}
+export { hostOf };

package/dist/{reader.d.mts → sources/hosted.d.mts}

@@ -1,7 +1,5 @@
-import "./shared/protocol.mjs";
-export interface GscdumpReaderOptions {
-  /** The Site to read: a Site ID, a Site URL, or its host. Optional when the credential holds one Site. */
-  site?: string;
+import "../source.mjs";
+export interface HostedSourceOptions {
   /** A gscdump user API key. Defaults to `GSCDUMP_API_KEY`, then the CLI's Hosted login. */
   apiKey?: string;
   /** Defaults to `GSCDUMP_API_ROOT`, then `https://gscdump.com/api`. */

package/dist/sources/hosted.mjs

@@ -0,0 +1,118 @@
+import { bearerOf, dashboardOrigin, resolveCredential } from "../credential.mjs";
+import { readAccount } from "../account.mjs";
+import { parseRecordReadRefusal } from "@gscdump/contracts";
+import { createGscdumpV1Client, isGscdumpV1Error } from "@gscdump/sdk/v1";
+function rowsBody(dimension, path, window, rowLimit) {
+	return {
+		dimensions: [dimension],
+		filter: { _filters: [{
+			dimension: "date",
+			operator: "between",
+			expression: window.start,
+			expression2: window.end
+		}, {
+			dimension: "page",
+			operator: "equals",
+			expression: path
+		}] },
+		orderBy: dimension === "date" ? {
+			column: "date",
+			dir: "asc"
+		} : {
+			column: "clicks",
+			dir: "desc"
+		},
+		rowLimit
+	};
+}
+function createHostedSource(options, deps) {
+	const apiRoot = (options.apiRoot ?? deps.env.GSCDUMP_API_ROOT ?? "https://gscdump.com/api").replace(/\/+$/, "");
+	let ready = null;
+	async function sites() {
+		const read = await readSites();
+		if (read._tag === "Blocked") ready = null;
+		return read;
+	}
+	async function readSites() {
+		const credential = await resolveCredential({
+			apiKey: options.apiKey,
+			apiRoot: options.apiRoot,
+			env: deps.env,
+			readCliAuthentication: deps.readCliAuthentication
+		});
+		if (!credential) return {
+			_tag: "Blocked",
+			context: { _tag: "CredentialMissing" }
+		};
+		const account = await readAccount(credential, deps.fetch);
+		if (account._tag === "Rejected") return {
+			_tag: "Blocked",
+			context: {
+				_tag: "CredentialRejected",
+				source: credential.source
+			}
+		};
+		if (account._tag === "Unavailable") return {
+			_tag: "Blocked",
+			context: {
+				_tag: "Unavailable",
+				message: account.message
+			}
+		};
+		ready = {
+			credential,
+			client: createGscdumpV1Client({
+				apiRoot: credential.apiRoot,
+				credential: bearerOf(credential),
+				fetch: deps.fetch
+			})
+		};
+		return {
+			_tag: "Ok",
+			sites: account.sites
+		};
+	}
+	async function readRows(siteId, body) {
+		if (!ready) return {
+			_tag: "Unauthorized",
+			context: { _tag: "CredentialMissing" }
+		};
+		const { client, credential } = ready;
+		return client.queryAnalyticsRows({
+			params: { siteId },
+			body
+		}).then((response) => ({
+			_tag: "Ok",
+			rows: response.data.rows
+		}), (error) => {
+			if (!isGscdumpV1Error(error)) throw error;
+			const refusal = parseRecordReadRefusal(error.details);
+			if (refusal) return {
+				_tag: "Refused",
+				refusal
+			};
+			if (error.code === "rate_limited") return { _tag: "RateLimited" };
+			if (error.status === 401 || error.status === 403) return {
+				_tag: "Unauthorized",
+				context: {
+					_tag: "CredentialRejected",
+					source: credential.source
+				}
+			};
+			return {
+				_tag: "Failed",
+				message: error.message,
+				requestId: error.requestId ?? null
+			};
+		});
+	}
+	return {
+		sites,
+		dailyRows: (siteId, path, window) => readRows(siteId, rowsBody("date", path, window, 400)),
+		queryRows: (siteId, path, window, limit) => readRows(siteId, rowsBody("query", path, window, limit)),
+		get dashboardOrigin() {
+			return dashboardOrigin(ready?.credential.apiRoot ?? apiRoot);
+		}
+	};
+}
+export { createHostedSource };