@gscdump/sdk 0.17.0 → 0.17.2

package/dist/index.mjs

@@ -166,6 +166,89 @@ function createAnalyticsClient(options = {}) {
 		}
 	};
 }
+function normalizeLifecycleUrl(url) {
+	return (url || "").replace(/^sc-domain:/, "").replace(/^https?:\/\//, "").replace(/^www\./, "").replace(/\/$/, "").toLowerCase();
+}
+function normalizeGscPropertyKey(url) {
+	const value = url || "";
+	if (!value) return "";
+	if (value.startsWith("sc-domain:")) return `domain:${normalizeLifecycleUrl(value)}`;
+	if (!/^https?:\/\//.test(value)) return "";
+	return `url:${normalizeLifecycleUrl(value)}`;
+}
+function analyticsStatusToSyncStatus(status) {
+	switch (status) {
+		case "ready":
+		case "queryable_live":
+		case "queryable_partial": return "synced";
+		case "syncing":
+		case "preparing": return "syncing";
+		case "failed": return "error";
+		default: return "pending";
+	}
+}
+function lifecycleSiteToUserSite(site) {
+	const syncStatus = analyticsStatusToSyncStatus(site.analytics.status);
+	return {
+		siteId: site.siteId,
+		siteUrl: site.gscPropertyUrl || site.requestedUrl,
+		analyticsSyncStatus: syncStatus,
+		analyticsSyncProgress: site.analytics.progress,
+		syncStatus,
+		syncProgress: site.analytics.progress,
+		indexingEligible: site.indexing.eligible,
+		indexingIneligibleReason: site.indexing.reason,
+		indexingPermissionLevel: site.permissionLevel,
+		indexingStatus: site.indexing.status === "ready" ? "complete" : site.indexing.status === "not_requested" ? "not_started" : "indexing",
+		indexingProgress: site.indexing.progress,
+		lastSyncAt: site.updatedAt ? Date.parse(site.updatedAt) : null,
+		newestDateSynced: site.analytics.syncedRange.newest,
+		oldestDateSynced: site.analytics.syncedRange.oldest
+	};
+}
+function lifecycleSiteToSyncStatus(site) {
+	const syncStatus = analyticsStatusToSyncStatus(site.analytics.status);
+	const completed = site.analytics.progress.completed;
+	const failed = site.analytics.progress.failed;
+	const total = site.analytics.progress.total;
+	const queued = Math.max(total - completed - failed, 0);
+	return {
+		siteUrl: site.gscPropertyUrl || site.requestedUrl,
+		syncStatus,
+		oldestDateAvailable: site.analytics.syncedRange.oldest,
+		oldestDateSynced: site.analytics.syncedRange.oldest,
+		newestDateSynced: site.analytics.syncedRange.newest,
+		lastSyncAt: site.updatedAt ? Date.parse(site.updatedAt) : null,
+		lastError: site.latestError?.message ?? null,
+		jobs: {
+			queued,
+			processing: [
+				"queued",
+				"preparing",
+				"syncing"
+			].includes(site.analytics.status) ? 1 : 0,
+			completed,
+			failed
+		},
+		progress: site.analytics.progress.percent,
+		jobProgress: site.analytics.progress.percent,
+		daysSynced: completed,
+		daysAvailable: total,
+		isSyncing: [
+			"queued",
+			"preparing",
+			"syncing"
+		].includes(site.analytics.status),
+		hasData: site.analytics.queryable,
+		isComplete: site.analytics.queryable && site.analytics.status === "ready",
+		tables: {}
+	};
+}
+function findLifecycleSite(lifecycle, siteIdOrPropertyUrl) {
+	const normalized = normalizeLifecycleUrl(siteIdOrPropertyUrl);
+	const propertyKey = normalizeGscPropertyKey(siteIdOrPropertyUrl);
+	return lifecycle.sites.find((site) => site.siteId === siteIdOrPropertyUrl || site.externalSiteId === siteIdOrPropertyUrl || !!propertyKey && normalizeGscPropertyKey(site.gscPropertyUrl) === propertyKey || !site.gscPropertyUrl && normalizeLifecycleUrl(site.requestedUrl) === normalized || !propertyKey && normalizeLifecycleUrl(site.requestedUrl) === normalized) ?? null;
+}
 const TRAILING_SLASH_RE$1 = /\/+$/;
 const LEADING_SLASH_RE = /^\/+/;
 function trimApiBase(apiBase) {
@@ -303,6 +386,35 @@ function createPartnerClient(options = {}) {
 			err.data = latest;
 			throw err;
 		},
+		async waitForUserLifecycleReady(userId, waitOptions = {}) {
+			const attempts = waitOptions.attempts ?? 12;
+			const intervalMs = waitOptions.intervalMs ?? 1e3;
+			let latest = null;
+			for (let attempt = 0; attempt < attempts; attempt++) {
+				latest = await request(partnerRoutes.users.lifecycle(userId));
+				const status = latest.account.status;
+				if (status === "ready") return latest;
+				if (status === "refresh_missing" || status === "scope_missing" || status === "reauth_required") throw new PartnerApiError({
+					kind: "auth",
+					statusCode: 401,
+					message: "Google Search Console authorization must be refreshed",
+					data: latest.account
+				});
+				if (status === "disconnected" || status === "oauth_received") throw new PartnerApiError({
+					kind: "provisioning",
+					statusCode: 409,
+					message: "gscdump user is not fully connected",
+					data: latest.account
+				});
+				if (attempt < attempts - 1) await sleep(intervalMs);
+			}
+			throw new PartnerApiError({
+				kind: "provisioning",
+				statusCode: 409,
+				message: "gscdump user database is still provisioning",
+				data: latest
+			});
+		},
 		getUserSites(userId) {
 			return request(partnerRoutes.users.sites(userId), {}, partnerEndpointSchemas.getUserSites.response);
 		},
@@ -332,8 +444,19 @@ function createPartnerClient(options = {}) {
 		getAnalysisSources(siteId, tables) {
 			return request(partnerRoutes.sites.analysisSources(siteId), { query: tablesQuery(tables) }, partnerEndpointSchemas.getAnalysisSources.response);
 		},
-		getSiteSyncStatus(siteId) {
-			return request(partnerRoutes.sites.syncStatus(siteId));
+		async getSiteSyncStatus(siteId, userId) {
+			if (!userId) return request(partnerRoutes.sites.syncStatus(siteId));
+			const site = findLifecycleSite(await request(partnerRoutes.users.lifecycle(userId)), siteId);
+			if (!site) throw new PartnerApiError({
+				kind: "not-found",
+				statusCode: 404,
+				message: "gscdump lifecycle site not found",
+				data: {
+					siteId,
+					userId
+				}
+			});
+			return lifecycleSiteToSyncStatus(site);
 		},
 		getData(siteId, state, queryOptions) {
 			if (shouldValidate(options, "request")) {
@@ -495,89 +618,6 @@ function createPartnerClient(options = {}) {
 	};
 }
 const createGscdumpClient = createPartnerClient;
-function normalizeLifecycleUrl(url) {
-	return (url || "").replace(/^sc-domain:/, "").replace(/^https?:\/\//, "").replace(/^www\./, "").replace(/\/$/, "").toLowerCase();
-}
-function normalizeGscPropertyKey(url) {
-	const value = url || "";
-	if (!value) return "";
-	if (value.startsWith("sc-domain:")) return `domain:${normalizeLifecycleUrl(value)}`;
-	if (!/^https?:\/\//.test(value)) return "";
-	return `url:${normalizeLifecycleUrl(value)}`;
-}
-function analyticsStatusToSyncStatus(status) {
-	switch (status) {
-		case "ready":
-		case "queryable_live":
-		case "queryable_partial": return "synced";
-		case "syncing":
-		case "preparing": return "syncing";
-		case "failed": return "error";
-		default: return "pending";
-	}
-}
-function lifecycleSiteToUserSite(site) {
-	const syncStatus = analyticsStatusToSyncStatus(site.analytics.status);
-	return {
-		siteId: site.siteId,
-		siteUrl: site.gscPropertyUrl || site.requestedUrl,
-		analyticsSyncStatus: syncStatus,
-		analyticsSyncProgress: site.analytics.progress,
-		syncStatus,
-		syncProgress: site.analytics.progress,
-		indexingEligible: site.indexing.eligible,
-		indexingIneligibleReason: site.indexing.reason,
-		indexingPermissionLevel: site.permissionLevel,
-		indexingStatus: site.indexing.status === "ready" ? "complete" : site.indexing.status === "not_requested" ? "not_started" : "indexing",
-		indexingProgress: site.indexing.progress,
-		lastSyncAt: site.updatedAt ? Date.parse(site.updatedAt) : null,
-		newestDateSynced: site.analytics.syncedRange.newest,
-		oldestDateSynced: site.analytics.syncedRange.oldest
-	};
-}
-function lifecycleSiteToSyncStatus(site) {
-	const syncStatus = analyticsStatusToSyncStatus(site.analytics.status);
-	const completed = site.analytics.progress.completed;
-	const failed = site.analytics.progress.failed;
-	const total = site.analytics.progress.total;
-	const queued = Math.max(total - completed - failed, 0);
-	return {
-		siteUrl: site.gscPropertyUrl || site.requestedUrl,
-		syncStatus,
-		oldestDateAvailable: site.analytics.syncedRange.oldest,
-		oldestDateSynced: site.analytics.syncedRange.oldest,
-		newestDateSynced: site.analytics.syncedRange.newest,
-		lastSyncAt: site.updatedAt ? Date.parse(site.updatedAt) : null,
-		lastError: site.latestError?.message ?? null,
-		jobs: {
-			queued,
-			processing: [
-				"queued",
-				"preparing",
-				"syncing"
-			].includes(site.analytics.status) ? 1 : 0,
-			completed,
-			failed
-		},
-		progress: site.analytics.progress.percent,
-		jobProgress: site.analytics.progress.percent,
-		daysSynced: completed,
-		daysAvailable: total,
-		isSyncing: [
-			"queued",
-			"preparing",
-			"syncing"
-		].includes(site.analytics.status),
-		hasData: site.analytics.queryable,
-		isComplete: site.analytics.queryable && site.analytics.status === "ready",
-		tables: {}
-	};
-}
-function findLifecycleSite(lifecycle, siteIdOrPropertyUrl) {
-	const normalized = normalizeLifecycleUrl(siteIdOrPropertyUrl);
-	const propertyKey = normalizeGscPropertyKey(siteIdOrPropertyUrl);
-	return lifecycle.sites.find((site) => site.siteId === siteIdOrPropertyUrl || site.externalSiteId === siteIdOrPropertyUrl || !!propertyKey && normalizeGscPropertyKey(site.gscPropertyUrl) === propertyKey || !site.gscPropertyUrl && normalizeLifecycleUrl(site.requestedUrl) === normalized || !propertyKey && normalizeLifecycleUrl(site.requestedUrl) === normalized) ?? null;
-}
 const HTTP_PROTOCOL_RE = /^http/i;
 const API_SUFFIX_RE = /\/api\/?$/;
 const TRAILING_SLASH_RE = /\/+$/;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/sdk",
   "type": "module",
-  "version": "0.17.0",
+  "version": "0.17.2",
   "description": "Consumer SDK for hosted gscdump.com integrations.",
   "author": {
     "name": "Harlan Wilton",
@@ -41,7 +41,7 @@
     "node": ">=18"
   },
   "peerDependencies": {
-    "gscdump": "0.17.0"
+    "gscdump": "0.17.2"
   },
   "peerDependenciesMeta": {
     "gscdump": {
@@ -51,7 +51,7 @@
   "dependencies": {
     "ofetch": "^1.5.1",
     "zod": "^4.4.3",
-    "@gscdump/contracts": "0.17.0"
+    "@gscdump/contracts": "0.17.2"
   },
   "devDependencies": {
     "typescript": "^6.0.3",