@gscdump/sdk 7.12.1 → 7.13.0

package/dist/indexing/trust-gate.mjs

@@ -0,0 +1,74 @@
+import { SITEMAP_TRUST_COLLAPSE_POLICY, classifySitemapCollapse, compareCurrentSitemapScope, sitemapHistoryHasCollapse } from "@gscdump/analysis/sitemap-health";
+const TRUST_DEGRADED_STATES = /* @__PURE__ */ new Set([
+	"unknown",
+	"blip",
+	"broken",
+	"no_sitemap"
+]);
+function isTrustDegraded(state) {
+	return TRUST_DEGRADED_STATES.has(state);
+}
+const STALE_DOWNLOAD_DAYS = 7;
+function newestFirstCounts(history) {
+	return history.toSorted((a, b) => b.date.localeCompare(a.date)).map((point) => point.urlCount);
+}
+function sitemapHistoryCollapsed(history) {
+	return sitemapHistoryHasCollapse(newestFirstCounts(history), SITEMAP_TRUST_COLLAPSE_POLICY);
+}
+function compareCurrentSitemapScope$1(history) {
+	return compareCurrentSitemapScope(newestFirstCounts(history), SITEMAP_TRUST_COLLAPSE_POLICY);
+}
+function classifyCurrentSitemapDrop(history) {
+	return classifySitemapCollapse(newestFirstCounts(history), SITEMAP_TRUST_COLLAPSE_POLICY);
+}
+function daysSince(iso, now) {
+	return (now.getTime() - new Date(iso).getTime()) / 864e5;
+}
+function computeTrustGate(input) {
+	if (!input.connected) return {
+		state: "not_connected",
+		reason: "Search Console is not connected."
+	};
+	const live = input.liveness;
+	if (input.noSitemapsSubmitted) return {
+		state: "no_sitemap",
+		reason: live?.status === "reachable" ? "Sitemap is reachable but not submitted in Search Console." : "No sitemap is submitted in Search Console."
+	};
+	if (live?.statusCode === 404) return {
+		state: "no_sitemap",
+		reason: "No sitemap found at /sitemap.xml."
+	};
+	const inspected = input.inspectedCount ?? input.totalUrls ?? 0;
+	if (input.sitemapsPending && inspected <= 0) return {
+		state: "pending",
+		reason: "Sitemap is submitted and waiting for Google to parse it."
+	};
+	if (inspected <= 0) return {
+		state: "pending",
+		reason: "Google has not inspected any URLs yet."
+	};
+	if (input.indexingStatus && input.indexingStatus !== "complete" && input.indexingStatus !== "partial") return {
+		state: "pending",
+		reason: "Search Console data is still syncing."
+	};
+	const corroborated = input.lastDownloadedAt != null && daysSince(input.lastDownloadedAt, input.now) >= 7 || input.sitemapCollapsed;
+	if (live && (live.status === "timeout" || live.status === "error")) {
+		if (corroborated) return {
+			state: "broken",
+			reason: live.status === "timeout" ? "Sitemap is timing out, so indexing cannot be confirmed." : "Sitemap is unreachable, so indexing cannot be confirmed."
+		};
+		return {
+			state: "blip",
+			reason: "Could not reach the sitemap just now, retrying."
+		};
+	}
+	if (!live && corroborated) return {
+		state: "unknown",
+		reason: "Indexing cannot be confirmed right now."
+	};
+	return {
+		state: "ok",
+		reason: "Google is indexing the pages it discovers."
+	};
+}
+export { STALE_DOWNLOAD_DAYS, TRUST_DEGRADED_STATES, classifyCurrentSitemapDrop, compareCurrentSitemapScope$1 as compareCurrentSitemapScope, computeTrustGate, isTrustDegraded, sitemapHistoryCollapsed };

package/dist/indexing/window.d.mts

@@ -0,0 +1,40 @@
+import { Period } from "../period.mjs";
+import { IndexingTrendReading } from "./readings.mjs";
+/** The hosted v1 Site indexing read accepts at most 90 days. */
+export declare const INDEXING_MAX_READ_DAYS = 90;
+/** The UTC days a portfolio indexing view shows, both ends inclusive. */
+export interface IndexingWindow {
+  /** `YYYY-MM-DD`. */
+  start: string;
+  /** `YYYY-MM-DD`. */
+  end: string;
+  /**
+   * True when the window ends at the latest reporting day. Its Sites show their
+   * summary. A past window shows each Site's trend reading at its end.
+   */
+  current: boolean;
+  /** The day count the indexing read sends, back from today. */
+  readDays: number;
+  /** The first day the read reaches. After `start` when the read cap cuts the window. */
+  readFrom: string;
+}
+/** The window days, `YYYY-MM-DD`, both ends inclusive. */
+export type IndexingWindowDays = Pick<IndexingWindow, 'start' | 'end'>;
+/** The window days, and whether the window ends at the latest reporting day. */
+export type IndexingReadingWindow = Pick<IndexingWindow, 'start' | 'end' | 'current'>;
+/**
+ * The Indexing window for a Period.
+ *
+ * Indexing readings have no reporting latency, so a Period that reaches the
+ * latest reporting day keeps its length and ends today. A past range keeps its
+ * own days. The indexing read takes a day count back from today only, at most
+ * 90. A current window asks for its own length. A past window reads back to its
+ * start, and to 28 days before its end, so the reading at the end has its
+ * changes. The cap can stop either short, because a longer request fails the
+ * whole read.
+ */
+export declare function indexingWindow(period: Period | string, stableData: boolean, now: Date): IndexingWindow;
+/** The days in the window that any series reports, oldest first. */
+export declare function readingDatesInWindow(series: readonly (readonly Pick<IndexingTrendReading, 'date'>[])[], window: IndexingWindowDays): string[];
+/** Says where the read stops when the read cap cuts the window start. Null when it reaches it. */
+export declare function indexingWindowNote(window: Pick<IndexingWindow, 'start' | 'end' | 'readFrom'>, series: readonly (readonly Pick<IndexingTrendReading, 'date'>[])[]): string | null;

package/dist/indexing/window.mjs

@@ -0,0 +1,45 @@
+import { periodToDateRange } from "../period.mjs";
+const INDEXING_MAX_READ_DAYS = 90;
+const INDEXING_CHANGE_DAYS = 28;
+const DAY_MS = 864e5;
+function isoDay(ms) {
+	return new Date(ms).toISOString().slice(0, 10);
+}
+function indexingWindow(period, stableData, now) {
+	const range = periodToDateRange(period, {
+		stableData,
+		now
+	});
+	const latest = periodToDateRange("7d", {
+		stableData,
+		now
+	}).end;
+	const todayMs = Date.parse(now.toISOString().slice(0, 10));
+	const isCurrent = range.end >= latest;
+	const startMs = isCurrent ? todayMs - (range.days - 1) * DAY_MS : Date.parse(range.start);
+	const endMs = isCurrent ? todayMs : Date.parse(range.end);
+	const firstMs = Math.min(startMs, endMs - INDEXING_CHANGE_DAYS * DAY_MS);
+	const readDays = Math.min(90, isCurrent ? range.days : Math.round((todayMs - firstMs) / DAY_MS) + 1);
+	return {
+		start: isoDay(startMs),
+		end: isoDay(endMs),
+		current: isCurrent,
+		readDays,
+		readFrom: isoDay(todayMs - (readDays - 1) * DAY_MS)
+	};
+}
+function readingDatesInWindow(series, window) {
+	return [...new Set(series.flatMap((points) => points.filter((point) => point.date >= window.start && point.date <= window.end).map((point) => point.date)))].sort();
+}
+const noteDateFormat = new Intl.DateTimeFormat("en-US", {
+	month: "short",
+	day: "numeric",
+	year: "numeric",
+	timeZone: "UTC"
+});
+function indexingWindowNote(window, series) {
+	if (window.readFrom <= window.start) return null;
+	const first = readingDatesInWindow(series, window)[0] ?? window.readFrom;
+	return `Shows ${noteDateFormat.format(/* @__PURE__ */ new Date(`${first}T00:00:00Z`))} onward. Indexing data goes back 90 days.`;
+}
+export { INDEXING_MAX_READ_DAYS, indexingWindow, indexingWindowNote, readingDatesInWindow };

package/dist/indexing.d.mts

@@ -0,0 +1,10 @@
+import { BuildIndexCohortInput, COHORT_MIN_CELL_SIZE, COHORT_MIN_ENUMERATED_SHARE, IndexCohortBaseline, IndexCohortCell, IndexCohortCoverage, IndexCohortDiagnosis, IndexCohortDimension, IndexCohortFilter, IndexCohortFilterParse, IndexCohortLead, IndexCohortLifecycle, IndexCohortPage, IndexCohortSectionRank, IndexCohortSource, IndexCohortUrlRow, IndexCohortsResponse, SITE_WIDE_NOT_INDEXED_RATE, belongsToIndexCohort, buildIndexCohortDiagnosis, buildIndexCohortsFromIndexingUrls, indexCohortFilterValue, parseIndexCohortFilter, rankIndexCohortSections, sampledIndexStateMessage, selectIndexCohortLead, selectIndexCohortUrls, wilsonInterval } from "./indexing/cohorts.mjs";
+import { CurrentSitemapScope, STALE_DOWNLOAD_DAYS, SitemapCollapseState, SitemapCountPoint, SitemapLivenessCheck, TRUST_DEGRADED_STATES, TrustGate, TrustGateInput, TrustGateState, classifyCurrentSitemapDrop, compareCurrentSitemapScope, computeTrustGate, isTrustDegraded, sitemapHistoryCollapsed } from "./indexing/trust-gate.mjs";
+import { AvailableInspectionStages, IndexingDiagnoseInput, IndexingDiagnosisActionId, IndexingDiagnosisReason, IndexingOverviewAction, IndexingOverviewCount, IndexingOverviewDiagnosis, IndexingOverviewDiagnosisState, IndexingOverviewInput, IndexingOverviewModel, IndexingOverviewPartialScope, IndexingOverviewReason, IndexingOverviewReasonGroup, IndexingOverviewScope, IndexingOverviewTrustFailure, IndexingOverviewVerifyScope, IndexingOverviewWaiting, IndexingReasonGroupId, InspectionStageCounts, InspectionStageRow, InspectionStageSource, InspectionStageStep, InspectionStageSteps, UnavailableInspectionStages, buildIndexingOverviewModel, countInspectionStages, indexingActionForIssue } from "./indexing/overview.mjs";
+import { IndexingSummaryReading, IndexingTrendReading, SiteIndexingReadings, clampIndexedPercent, crawlErrorCount, notIndexedCount, readSiteIndexing } from "./indexing/readings.mjs";
+import { SiteIndexingIssue, SiteIndexingIssuePoint, getSiteIndexingIssues } from "./indexing/site-issues.mjs";
+import { INDEXING_MAX_READ_DAYS, IndexingReadingWindow, IndexingWindow, IndexingWindowDays, indexingWindow, indexingWindowNote, readingDatesInWindow } from "./indexing/window.mjs";
+import { IndexingPortfolioSite, IndexingStack, IndexingStackBucket, IndexingStackOptions, IndexingStackSeries, IndexingWindowReading, PortfolioIndexingTrendPoint, PortfolioIssueRow, PortfolioIssueSiteCount, indexedRateChange, issueStack, notIndexedStack, portfolioIndexingTrend, portfolioIssueCounts, portfolioRateChangeOver, siteIndexingReading, windowReadings } from "./indexing/portfolio.mjs";
+import { IndexingMarkdownBucket, IndexingMarkdownInput, IndexingMarkdownIssues, IndexingMarkdownSite, IndexingMarkdownTrendPoint, bucketIndexingSeries, buildIndexingPortfolioMarkdown, indexingMarkdownBucketDays } from "./indexing/portfolio-markdown.mjs";
+import { IndexingRegressionLead, IndexingTransitionRow, selectIndexingRegressionLead } from "./indexing/regression-lead.mjs";
+export { AvailableInspectionStages, BuildIndexCohortInput, COHORT_MIN_CELL_SIZE, COHORT_MIN_ENUMERATED_SHARE, type CurrentSitemapScope, INDEXING_MAX_READ_DAYS, IndexCohortBaseline, IndexCohortCell, IndexCohortCoverage, IndexCohortDiagnosis, IndexCohortDimension, IndexCohortFilter, IndexCohortFilterParse, IndexCohortLead, IndexCohortLifecycle, IndexCohortPage, IndexCohortSectionRank, IndexCohortSource, IndexCohortUrlRow, IndexCohortsResponse, IndexingDiagnoseInput, IndexingDiagnosisActionId, IndexingDiagnosisReason, IndexingMarkdownBucket, IndexingMarkdownInput, IndexingMarkdownIssues, IndexingMarkdownSite, IndexingMarkdownTrendPoint, IndexingOverviewAction, IndexingOverviewCount, IndexingOverviewDiagnosis, IndexingOverviewDiagnosisState, IndexingOverviewInput, IndexingOverviewModel, IndexingOverviewPartialScope, IndexingOverviewReason, IndexingOverviewReasonGroup, IndexingOverviewScope, IndexingOverviewTrustFailure, IndexingOverviewVerifyScope, IndexingOverviewWaiting, IndexingPortfolioSite, IndexingReadingWindow, IndexingReasonGroupId, IndexingRegressionLead, IndexingStack, IndexingStackBucket, IndexingStackOptions, IndexingStackSeries, IndexingSummaryReading, IndexingTransitionRow, IndexingTrendReading, IndexingWindow, IndexingWindowDays, IndexingWindowReading, InspectionStageCounts, InspectionStageRow, InspectionStageSource, InspectionStageStep, InspectionStageSteps, PortfolioIndexingTrendPoint, PortfolioIssueRow, PortfolioIssueSiteCount, SITE_WIDE_NOT_INDEXED_RATE, STALE_DOWNLOAD_DAYS, SiteIndexingIssue, SiteIndexingIssuePoint, SiteIndexingReadings, type SitemapCollapseState, SitemapCountPoint, SitemapLivenessCheck, TRUST_DEGRADED_STATES, TrustGate, TrustGateInput, TrustGateState, UnavailableInspectionStages, belongsToIndexCohort, bucketIndexingSeries, buildIndexCohortDiagnosis, buildIndexCohortsFromIndexingUrls, buildIndexingOverviewModel, buildIndexingPortfolioMarkdown, clampIndexedPercent, classifyCurrentSitemapDrop, compareCurrentSitemapScope, computeTrustGate, countInspectionStages, crawlErrorCount, getSiteIndexingIssues, indexCohortFilterValue, indexedRateChange, indexingActionForIssue, indexingMarkdownBucketDays, indexingWindow, indexingWindowNote, isTrustDegraded, issueStack, notIndexedCount, notIndexedStack, parseIndexCohortFilter, portfolioIndexingTrend, portfolioIssueCounts, portfolioRateChangeOver, rankIndexCohortSections, readSiteIndexing, readingDatesInWindow, sampledIndexStateMessage, selectIndexCohortLead, selectIndexCohortUrls, selectIndexingRegressionLead, siteIndexingReading, sitemapHistoryCollapsed, wilsonInterval, windowReadings };

package/dist/indexing.mjs

@@ -0,0 +1,10 @@
+import { COHORT_MIN_CELL_SIZE, COHORT_MIN_ENUMERATED_SHARE, SITE_WIDE_NOT_INDEXED_RATE, belongsToIndexCohort, buildIndexCohortDiagnosis, buildIndexCohortsFromIndexingUrls, indexCohortFilterValue, parseIndexCohortFilter, rankIndexCohortSections, sampledIndexStateMessage, selectIndexCohortLead, selectIndexCohortUrls, wilsonInterval } from "./indexing/cohorts.mjs";
+import { STALE_DOWNLOAD_DAYS, TRUST_DEGRADED_STATES, classifyCurrentSitemapDrop, compareCurrentSitemapScope, computeTrustGate, isTrustDegraded, sitemapHistoryCollapsed } from "./indexing/trust-gate.mjs";
+import { buildIndexingOverviewModel, countInspectionStages, indexingActionForIssue } from "./indexing/overview.mjs";
+import { clampIndexedPercent, crawlErrorCount, notIndexedCount, readSiteIndexing } from "./indexing/readings.mjs";
+import { getSiteIndexingIssues } from "./indexing/site-issues.mjs";
+import { INDEXING_MAX_READ_DAYS, indexingWindow, indexingWindowNote, readingDatesInWindow } from "./indexing/window.mjs";
+import { indexedRateChange, issueStack, notIndexedStack, portfolioIndexingTrend, portfolioIssueCounts, portfolioRateChangeOver, siteIndexingReading, windowReadings } from "./indexing/portfolio.mjs";
+import { bucketIndexingSeries, buildIndexingPortfolioMarkdown, indexingMarkdownBucketDays } from "./indexing/portfolio-markdown.mjs";
+import { selectIndexingRegressionLead } from "./indexing/regression-lead.mjs";
+export { COHORT_MIN_CELL_SIZE, COHORT_MIN_ENUMERATED_SHARE, INDEXING_MAX_READ_DAYS, SITE_WIDE_NOT_INDEXED_RATE, STALE_DOWNLOAD_DAYS, TRUST_DEGRADED_STATES, belongsToIndexCohort, bucketIndexingSeries, buildIndexCohortDiagnosis, buildIndexCohortsFromIndexingUrls, buildIndexingOverviewModel, buildIndexingPortfolioMarkdown, clampIndexedPercent, classifyCurrentSitemapDrop, compareCurrentSitemapScope, computeTrustGate, countInspectionStages, crawlErrorCount, getSiteIndexingIssues, indexCohortFilterValue, indexedRateChange, indexingActionForIssue, indexingMarkdownBucketDays, indexingWindow, indexingWindowNote, isTrustDegraded, issueStack, notIndexedCount, notIndexedStack, parseIndexCohortFilter, portfolioIndexingTrend, portfolioIssueCounts, portfolioRateChangeOver, rankIndexCohortSections, readSiteIndexing, readingDatesInWindow, sampledIndexStateMessage, selectIndexCohortLead, selectIndexCohortUrls, selectIndexingRegressionLead, siteIndexingReading, sitemapHistoryCollapsed, wilsonInterval, windowReadings };

package/dist/package.mjs

@@ -1,2 +1,2 @@
-var version = "7.12.1";
+var version = "7.13.0";
 export { version };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/sdk",
   "type": "module",
-  "version": "7.12.1",
+  "version": "7.13.0",
   "description": "Consumer SDK for hosted gscdump.com integrations.",
   "author": {
     "name": "Harlan Wilton",
@@ -86,6 +86,11 @@
       "import": "./dist/hosted-query.mjs",
       "default": "./dist/hosted-query.mjs"
     },
+    "./indexing": {
+      "types": "./dist/indexing.d.mts",
+      "import": "./dist/indexing.mjs",
+      "default": "./dist/indexing.mjs"
+    },
     "./indexing-issues": {
       "types": "./dist/indexing-issues.d.mts",
       "import": "./dist/indexing-issues.mjs",
@@ -144,8 +149,9 @@
     "node": ">=22.13.0"
   },
   "dependencies": {
-    "@gscdump/contracts": "^7.12.1",
-    "gscdump": "^7.12.1",
+    "@gscdump/analysis": "^7.13.0",
+    "@gscdump/contracts": "^7.13.0",
+    "gscdump": "^7.13.0",
     "ofetch": "^1.5.1",
     "zod": "^4.6.5"
   },