@gscdump/contracts 0.39.0 → 0.40.2

package/dist/_chunks/schemas.mjs

@@ -1,91 +1,133 @@
-import { GSCDUMP_ONBOARDING_CONTRACT_VERSION, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, indexingNextActions, indexingStatuses, lifecycleErrorCodes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses } from "./onboarding.mjs";
 import { z } from "zod";
-const partnerRoutes = {
-	partner: {
-		users: {
-			byId: (userId) => `/partner/users/${encodeURIComponent(userId)}`,
-			lifecycle: (userId) => `/partner/users/${encodeURIComponent(userId)}/lifecycle`,
-			siteTeam: (userId, siteId) => `/partner/users/${encodeURIComponent(userId)}/sites/${encodeURIComponent(siteId)}`
-		},
-		sites: {
-			register: "/partner/sites/register",
-			bulkRegister: "/partner/sites/bulk-register"
-		}
-	},
-	users: {
-		register: "/users/register",
-		tokens: (userId) => `/users/${encodeURIComponent(userId)}/tokens`,
-		status: (userId) => `/users/${encodeURIComponent(userId)}/status`,
-		lifecycle: (userId) => `/users/${encodeURIComponent(userId)}/lifecycle`,
-		sites: (userId) => `/users/${encodeURIComponent(userId)}/sites`,
-		availableSites: (userId) => `/users/${encodeURIComponent(userId)}/available-sites`,
-		siteTeam: (userId, siteId) => `/partner/users/${encodeURIComponent(userId)}/sites/${encodeURIComponent(siteId)}`
-	},
-	sites: {
-		register: "/sites/register",
-		bulkRegister: "/sites/bulk-register",
-		byId: (siteId) => `/sites/${encodeURIComponent(siteId)}`,
-		analysisSources: (siteId) => `/sites/${encodeURIComponent(siteId)}/analysis-sources`,
-		syncStatus: (siteId) => `/sites/${encodeURIComponent(siteId)}/sync-status`,
-		data: (siteId) => `/sites/${encodeURIComponent(siteId)}/data`,
-		dataDetail: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/detail`,
-		analysis: (siteId) => `/sites/${encodeURIComponent(siteId)}/analysis`,
-		sitemaps: (siteId) => `/sites/${encodeURIComponent(siteId)}/sitemaps`,
-		sitemapChanges: (siteId) => `/sites/${encodeURIComponent(siteId)}/sitemaps/changes`,
-		indexing: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing`,
-		indexingUrls: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/urls`,
-		indexingDiagnostics: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/diagnostics`,
-		indexingInspect: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/inspect`,
-		recoverPermission: (siteId) => `/sites/${encodeURIComponent(siteId)}/recover-permission`,
-		canonicalMismatches: (siteId) => `/sites/${encodeURIComponent(siteId)}/canonical-mismatches`,
-		topAssociation: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/top-association`,
-		keywordSparklines: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/keyword-sparklines`,
-		queryTrend: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/query-trend`,
-		pageTrend: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/page-trend`,
-		contentVelocity: (siteId) => `/sites/${encodeURIComponent(siteId)}/content-velocity`,
-		ctrCurve: (siteId) => `/sites/${encodeURIComponent(siteId)}/ctr-curve`,
-		darkTraffic: (siteId) => `/sites/${encodeURIComponent(siteId)}/dark-traffic`,
-		deviceGap: (siteId) => `/sites/${encodeURIComponent(siteId)}/device-gap`,
-		indexPercent: (siteId) => `/sites/${encodeURIComponent(siteId)}/index-percent`,
-		keywordBreadth: (siteId) => `/sites/${encodeURIComponent(siteId)}/keyword-breadth`,
-		positionDistribution: (siteId) => `/sites/${encodeURIComponent(siteId)}/position-distribution`
-	},
-	settings: { user: "/user/settings" },
-	teams: {
-		create: "/partner/teams",
-		byId: (teamId) => `/partner/teams/${encodeURIComponent(teamId)}`,
-		members: (teamId) => `/partner/teams/${encodeURIComponent(teamId)}/members`,
-		member: (teamId, userId) => `/partner/teams/${encodeURIComponent(teamId)}/members/${encodeURIComponent(userId)}`
-	},
-	realtime: {
-		partner: "/ws/partner",
-		user: "/ws/user"
-	}
-};
-const analyticsRoutes = {
-	whoami: "/api/__gsc/whoami",
-	sites: "/api/__gsc/sites",
-	site: {
-		sourceInfo: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/source-info`,
-		analysisSources: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/analysis-sources`,
-		analyze: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/analyze`,
-		rows: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/rows`,
-		rollup: (siteId, rollupId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/rollup/${encodeURIComponent(rollupId)}`,
-		backfill: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/backfill`,
-		sitemaps: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/sitemaps`,
-		sitemapHistory: (siteId, hash) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/sitemaps/${encodeURIComponent(hash)}`,
-		sitemapChanges: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/sitemaps/changes`,
-		inspections: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/inspections`,
-		inspectionHistory: (siteId, hash) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/inspections/${encodeURIComponent(hash)}`,
-		indexingUrls: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/urls`,
-		indexingDiagnostics: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/diagnostics`,
-		indexingInspect: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/inspect`,
-		countries: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/countries`,
-		searchAppearance: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/search-appearance`,
-		topAssociation: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/data/top-association`
-	},
-	syncProgress: "/api/sync-progress"
-};
+const GSCDUMP_ONBOARDING_CONTRACT_VERSION = "2026-05-11";
+const GSCDUMP_REQUIRED_ANALYTICS_SCOPE = "https://www.googleapis.com/auth/webmasters.readonly";
+const GSCDUMP_WRITE_ANALYTICS_SCOPE = "https://www.googleapis.com/auth/webmasters";
+const GSCDUMP_OPTIONAL_INDEXING_SCOPE = "https://www.googleapis.com/auth/indexing";
+const accountStatuses = [
+	"disconnected",
+	"oauth_received",
+	"scope_missing",
+	"refresh_missing",
+	"db_provisioning",
+	"ready",
+	"reauth_required"
+];
+const accountNextActions = [
+	"connect_google",
+	"reconnect_google",
+	"wait_for_provisioning",
+	"none"
+];
+const propertyStatuses = [
+	"no_local_site",
+	"no_gsc_property",
+	"unverified_property",
+	"verified_candidate",
+	"registered",
+	"linked"
+];
+const propertyNextActions = [
+	"create_site",
+	"verify_gsc_property",
+	"choose_property",
+	"register_site",
+	"none"
+];
+const analyticsStatuses = [
+	"not_registered",
+	"queued",
+	"preparing",
+	"syncing",
+	"queryable_live",
+	"queryable_partial",
+	"ready",
+	"failed"
+];
+const analyticsNextActions = [
+	"wait_for_sync",
+	"retry_sync",
+	"none"
+];
+const querySourceModes = [
+	"none",
+	"live",
+	"d1",
+	"r2",
+	"mixed"
+];
+const sitemapStatuses = [
+	"unknown",
+	"discovering",
+	"none_found",
+	"auto_submitted",
+	"syncing",
+	"ready",
+	"failed"
+];
+const sitemapNextActions = [
+	"submit_sitemap",
+	"wait_for_sitemaps",
+	"retry_sitemaps",
+	"none"
+];
+const indexingStatuses = [
+	"not_requested",
+	"missing_scope",
+	"insufficient_permission",
+	"waiting_for_sitemaps",
+	"discovering",
+	"checking",
+	"ready",
+	"budget_exhausted",
+	"no_urls",
+	"failed"
+];
+const indexingNextActions = [
+	"reconnect_google",
+	"fix_gsc_permission",
+	"wait_for_sitemaps",
+	"wait_for_indexing",
+	"retry_indexing",
+	"none"
+];
+const lifecycleWebhookEvents = [
+	"user.lifecycle.changed",
+	"site.lifecycle.changed",
+	"site.analytics.ready",
+	"site.indexing.ready",
+	"site.auth.failed",
+	"job.failed"
+];
+const lifecycleErrorCodes = [
+	"missing_refresh_token",
+	"missing_analytics_scope",
+	"missing_indexing_scope",
+	"token_refresh_failed",
+	"permission_lost",
+	"insufficient_gsc_permission",
+	"gsc_property_not_found",
+	"gsc_property_unverified",
+	"user_database_not_provisioned",
+	"sync_failed",
+	"sitemap_sync_failed",
+	"indexing_failed"
+];
+function parseGrantedScopes(scopes) {
+	if (!scopes) return [];
+	if (typeof scopes === "string") return scopes.split(/\s+/).map((scope) => scope.trim()).filter(Boolean);
+	return scopes.map((scope) => scope.trim()).filter(Boolean);
+}
+function hasGoogleScope(scopes, scope) {
+	const granted = parseGrantedScopes(scopes);
+	const suffix = scope.replace("https://www.googleapis.com/auth/", "");
+	return granted.includes(scope) || granted.includes(suffix);
+}
+function hasRequiredAnalyticsScope(scopes) {
+	return hasGoogleScope(scopes, "https://www.googleapis.com/auth/webmasters.readonly") || hasGoogleScope(scopes, "https://www.googleapis.com/auth/webmasters");
+}
+function hasOptionalIndexingScope(scopes) {
+	return hasGoogleScope(scopes, GSCDUMP_OPTIONAL_INDEXING_SCOPE);
+}
 const WEBHOOK_CONTRACT_VERSION = "2026-05-11";
 const WEBHOOK_SIGNATURE_HEADER = "X-GSCDump-Signature";
 const WEBHOOK_EVENT_HEADER = "X-GSCDump-Event";
@@ -383,7 +425,7 @@ const gscdumpMetaSchema = z.object({
 	syncStatus: z.string(),
 	newestDateSynced: z.string().nullable(),
 	oldestDateSynced: z.string().nullable(),
-	dataDelay: z.string(),
+	dataDelay: z.string().optional(),
 	dataEndDate: z.string().nullable().optional(),
 	warnings: z.array(z.string()).optional(),
 	enrichment: z.object({
@@ -415,6 +457,13 @@ const gscdumpDataDetailResponseSchema = z.object({
 		ctr: z.number(),
 		position: z.number()
 	}).loose()),
+	previousDaily: z.array(z.object({
+		date: z.string(),
+		clicks: z.number(),
+		impressions: z.number(),
+		ctr: z.number(),
+		position: z.number()
+	}).loose()).optional(),
 	totals: gscdumpTotalsSchema,
 	previousTotals: gscdumpTotalsSchema.optional(),
 	meta: gscdumpMetaSchema
@@ -567,9 +616,14 @@ const gscdumpSiteRegistrationSchema = z.object({
 	message: z.string().optional(),
 	existing: z.boolean().optional(),
 	indexingEligible: z.boolean().optional(),
-	indexingIneligibleReason: z.enum(["missing_indexing_scope", "insufficient_gsc_permission"]).optional(),
+	indexingIneligibleReason: z.enum([
+		"free_plan",
+		"missing_indexing_scope",
+		"insufficient_gsc_permission"
+	]).optional(),
 	indexingPermissionLevel: z.string().nullable().optional(),
-	grantedScopes: z.array(z.string()).optional()
+	grantedScopes: z.array(z.string()).optional(),
+	site: partnerLifecycleSiteSchema.nullable().optional()
 }).loose();
 const registerPartnerSiteSchema = z.object({
 	userId: z.string(),
@@ -611,7 +665,11 @@ const bulkRegisterPartnerSitesResponseSchema = z.object({
 		error: z.string().optional(),
 		site: unknownRecord.nullable().optional(),
 		indexingEligible: z.boolean().optional(),
-		indexingIneligibleReason: z.enum(["missing_indexing_scope", "insufficient_gsc_permission"]).optional(),
+		indexingIneligibleReason: z.enum([
+			"free_plan",
+			"missing_indexing_scope",
+			"insufficient_gsc_permission"
+		]).optional(),
 		indexingPermissionLevel: z.string().nullable().optional(),
 		grantedScopes: z.array(z.string()).optional()
 	}).loose()),
@@ -652,8 +710,7 @@ const gscdumpAnalysisPresetSchema = z.enum([
 	"movers-rising",
 	"movers-declining"
 ]);
-const gscdumpAnalysisParamsSchema = z.object({
-	preset: gscdumpAnalysisPresetSchema,
+const gscdumpAnalysisBaseParamsSchema = z.object({
 	startDate: z.string(),
 	endDate: z.string(),
 	prevStartDate: z.string().optional(),
@@ -667,19 +724,52 @@ const gscdumpAnalysisParamsSchema = z.object({
 	maxPosition: z.number().optional(),
 	maxCtr: z.number().optional(),
 	searchType: searchTypeSchema.optional()
-}).superRefine((value, ctx) => {
+});
+const gscdumpAnalysisParamsSchema = gscdumpAnalysisBaseParamsSchema.extend({ preset: gscdumpAnalysisPresetSchema }).superRefine((value, ctx) => {
 	if ((value.preset === "brand-only" || value.preset === "non-brand") && !value.brandTerms?.trim()) ctx.addIssue({
 		code: "custom",
 		path: ["brandTerms"],
 		message: "brandTerms is required for brand/non-brand presets"
 	});
 });
+const gscdumpAnalysisBundleParamsSchema = gscdumpAnalysisBaseParamsSchema.extend({ presets: z.array(gscdumpAnalysisPresetSchema).min(1).max(8) }).superRefine((value, ctx) => {
+	if (value.presets.some((preset) => preset === "brand-only" || preset === "non-brand") && !value.brandTerms?.trim()) ctx.addIssue({
+		code: "custom",
+		path: ["brandTerms"],
+		message: "brandTerms is required for brand/non-brand presets"
+	});
+	if (value.presets.some((preset) => preset === "movers-rising" || preset === "movers-declining" || preset === "decay") && (!value.prevStartDate || !value.prevEndDate)) ctx.addIssue({
+		code: "custom",
+		path: ["prevStartDate"],
+		message: "prevStartDate and prevEndDate are required for comparison presets"
+	});
+});
+const gscdumpAnalysisMetaSchema = z.object({
+	siteUrl: z.string(),
+	params: z.object({
+		brandTerms: z.array(z.string()).optional(),
+		startDate: z.string().optional(),
+		endDate: z.string().optional(),
+		prevStartDate: z.string().optional(),
+		prevEndDate: z.string().optional()
+	}),
+	presetDescription: z.string().optional()
+}).loose();
 const gscdumpAnalysisResponseSchema = z.object({
 	preset: gscdumpAnalysisPresetSchema,
 	keywords: z.array(unknownRecord),
 	totalCount: z.number(),
-	summary: unknownRecord.optional(),
-	meta: gscdumpMetaSchema
+	summary: unknownRecord.nullable().optional(),
+	meta: gscdumpAnalysisMetaSchema
+}).loose();
+const gscdumpAnalysisBundleResponseSchema = z.object({
+	bundle: z.record(z.string(), z.object({
+		keywords: z.array(unknownRecord),
+		totalCount: z.number(),
+		summary: unknownRecord.nullable().optional(),
+		presetDescription: z.string()
+	})),
+	meta: gscdumpAnalysisMetaSchema
 }).loose();
 const gscdumpSitemapsResponseSchema = z.object({
 	sitemaps: z.array(z.object({
@@ -688,8 +778,11 @@ const gscdumpSitemapsResponseSchema = z.object({
 		errors: z.number(),
 		warnings: z.number(),
 		isIndex: z.boolean().optional(),
-		lastSubmitted: z.string().nullable().optional(),
-		lastDownloaded: z.string().nullable().optional()
+		contentHash: z.string().nullable().optional(),
+		lastDownloaded: z.string().nullable().optional(),
+		lastError: z.string().nullable().optional(),
+		isPending: z.boolean().optional(),
+		fetchedAt: z.number().nullable().optional()
 	}).loose()),
 	history: z.array(z.object({
 		date: z.string(),
@@ -706,6 +799,7 @@ const gscdumpSitemapsResponseSchema = z.object({
 	}).loose())),
 	meta: z.object({
 		siteUrl: z.string(),
+		gscPropertyUrl: z.string(),
 		syncStatus: z.string().nullable()
 	}).loose()
 }).loose();
@@ -1504,4 +1598,4 @@ const partnerEndpointSchemas = {
 	...analyticsEndpointSchemas,
 	...partnerControlEndpointSchemas
 };
-export { CANONICAL_WEBHOOK_EVENTS, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, addPartnerTeamMemberSchema, analyticsEndpointSchemas, analyticsRoutes, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, builderStateSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDateRangeParamsSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPageTrendParamsSchema, gscdumpPageTrendResponseSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, indexingDiagnosticsParamsSchema, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, jobFailedWebhookPayloadSchema, lifecycleErrorSchema, lifecycleProgressSchema, partnerControlEndpointSchemas, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sourceInfoResponseSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };
+export { CANONICAL_WEBHOOK_EVENTS, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, accountNextActions, accountStatuses, addPartnerTeamMemberSchema, analyticsEndpointSchemas, analyticsNextActions, analyticsStatuses, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, builderStateSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscdumpAnalysisBaseParamsSchema, gscdumpAnalysisBundleParamsSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisMetaSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDateRangeParamsSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPageTrendParamsSchema, gscdumpPageTrendResponseSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingDiagnosticsParamsSchema, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingNextActions, indexingStatuses, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, parseGrantedScopes, partnerControlEndpointSchemas, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };

package/dist/_chunks/types.d.mts

@@ -657,7 +657,7 @@ interface GscdumpMeta {
   syncStatus: string;
   newestDateSynced: string | null;
   oldestDateSynced: string | null;
-  dataDelay: string;
+  dataDelay?: string;
   dataEndDate?: string | null;
   warnings?: string[];
   enrichment?: {
@@ -689,6 +689,13 @@ interface GscdumpDataDetailResponse {
     ctr: number;
     position: number;
   }>;
+  previousDaily?: Array<{
+    date: string;
+    clicks: number;
+    impressions: number;
+    ctr: number;
+    position: number;
+  }>;
   totals: GscdumpTotals;
   previousTotals?: GscdumpTotals;
   meta: GscdumpMeta;
@@ -722,7 +729,7 @@ interface GscdumpAvailableSite {
   siteId?: string;
   /** Integer alias (`user_sites.int_id`) — the int JOIN key partners denormalize into their own catalog namespaces. Present on registered sites. */
   intId?: number | null;
-  syncStatus?: 'pending' | 'syncing' | 'synced' | 'error';
+  syncStatus?: 'pending' | 'syncing' | 'synced' | 'error' | null;
   syncProgress?: {
     completed: number;
     failed?: number;
@@ -743,9 +750,10 @@ interface GscdumpSiteRegistration {
   message?: string;
   existing?: boolean;
   indexingEligible?: boolean;
-  indexingIneligibleReason?: 'missing_indexing_scope' | 'insufficient_gsc_permission';
+  indexingIneligibleReason?: 'free_plan' | 'missing_indexing_scope' | 'insufficient_gsc_permission';
   indexingPermissionLevel?: string | null;
   grantedScopes?: string[];
+  site?: PartnerLifecycleSite | null;
 }
 interface GscdumpUserSite {
   siteId: string;
@@ -765,7 +773,7 @@ interface GscdumpUserSite {
     percent: number;
   };
   indexingEligible?: boolean;
-  indexingIneligibleReason?: 'missing_indexing_scope' | 'insufficient_gsc_permission';
+  indexingIneligibleReason?: 'free_plan' | 'missing_indexing_scope' | 'insufficient_gsc_permission';
   indexingPermissionLevel?: string | null;
   grantedScopes?: string[];
   indexingStatus?: 'not_started' | 'indexing' | 'complete';
@@ -1033,8 +1041,30 @@ interface GscdumpAnalysisResponse {
   preset: GscdumpAnalysisPreset;
   keywords: Array<Record<string, unknown>>;
   totalCount: number;
-  summary?: Record<string, unknown>;
-  meta: GscdumpMeta;
+  summary?: Record<string, unknown> | null;
+  meta: {
+    siteUrl: string;
+    params: {
+      brandTerms?: string[];
+      startDate?: string;
+      endDate?: string;
+      prevStartDate?: string;
+      prevEndDate?: string;
+    };
+    presetDescription?: string;
+  };
+}
+interface GscdumpAnalysisBundleParams extends Omit<GscdumpAnalysisParams, 'preset'> {
+  presets: GscdumpAnalysisPreset[];
+}
+interface GscdumpAnalysisBundleResponse {
+  bundle: Record<string, {
+    keywords: Array<Record<string, unknown>>;
+    totalCount: number;
+    summary?: Record<string, unknown> | null;
+    presetDescription: string;
+  }>;
+  meta: GscdumpAnalysisResponse['meta'];
 }
 interface RegisterPartnerUserParams {
   userGoogleId: string;
@@ -1083,7 +1113,7 @@ interface BulkRegisterPartnerSiteResult {
   error?: string;
   site?: PartnerLifecycleSite | null;
   indexingEligible?: boolean;
-  indexingIneligibleReason?: 'missing_indexing_scope' | 'insufficient_gsc_permission';
+  indexingIneligibleReason?: 'free_plan' | 'missing_indexing_scope' | 'insufficient_gsc_permission';
   indexingPermissionLevel?: string | null;
   grantedScopes?: string[];
 }
@@ -1568,157 +1598,6 @@ interface PartnerClient {
     teamId: string | null;
   }>;
 }
-type PartnerRealtimeEventType = 'sync.progress' | 'sync.complete' | 'sync.job_complete' | 'sync.site_complete' | 'sync.failed' | 'job.failed' | 'auth.failed' | 'auth.needs_reauth' | 'site.added' | 'site.removed' | 'enrichment.complete' | 'sitemap.progress' | 'sitemap.complete' | 'indexing.progress' | 'indexing.complete';
-interface RealtimeSyncProgressEvent {
-  event: 'sync.progress';
-  siteId: string;
-  siteUrl: string;
-  table: string;
-  date: string;
-  progress: number;
-}
-interface RealtimeSyncCompleteEvent {
-  event: 'sync.complete';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  table: string;
-  date: string;
-  rowsFetched: number;
-  rowsInserted: number;
-  timestamp: number;
-}
-interface RealtimeSyncJobCompleteEvent {
-  event: 'sync.job_complete';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  table: string;
-  date: string;
-  rowsFetched: number;
-  rowsInserted: number;
-  syncStatus: string;
-  timestamp: number;
-}
-interface RealtimeSyncSiteCompleteEvent {
-  event: 'sync.site_complete';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  syncStatus: string;
-  timestamp: number;
-}
-interface RealtimeSyncFailedEvent {
-  event: 'sync.failed';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  table: string;
-  date: string;
-  error: string;
-  timestamp: number;
-}
-interface RealtimeJobFailedEvent {
-  event: 'job.failed';
-  siteId: string;
-  siteUrl: string;
-  table: string;
-  date: string;
-  error: string;
-  timestamp: number;
-}
-interface RealtimeSiteAddedEvent {
-  event: 'site.added';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-}
-interface RealtimeSiteRemovedEvent {
-  event: 'site.removed';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-}
-interface RealtimeAuthFailedEvent {
-  event: 'auth.failed';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  error: string;
-  timestamp: number;
-}
-interface RealtimeNeedsReauthEvent {
-  event: 'auth.needs_reauth';
-  userId: number;
-  failureCount: number;
-  timestamp: number;
-}
-interface RealtimeEnrichmentCompleteEvent {
-  event: 'enrichment.complete';
-  siteId: string;
-  userId: number;
-  timestamp: number;
-}
-interface RealtimeSitemapProgressEvent {
-  event: 'sitemap.progress';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  discovered: number;
-  total: number;
-  progress: number;
-}
-interface RealtimeSitemapCompleteEvent {
-  event: 'sitemap.complete';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  discoveredCount: number;
-  timestamp: number;
-}
-interface RealtimeIndexingProgressEvent {
-  event: 'indexing.progress';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  checked: number;
-  total: number;
-  progress: number;
-}
-interface RealtimeIndexingCompleteEvent {
-  event: 'indexing.complete';
-  userId: number;
-  siteId: string;
-  siteUrl: string;
-  totalUrls: number;
-  indexedCount: number;
-  timestamp: number;
-}
-type PartnerRealtimeEvent = RealtimeSyncProgressEvent | RealtimeSyncCompleteEvent | RealtimeSyncJobCompleteEvent | RealtimeSyncSiteCompleteEvent | RealtimeSyncFailedEvent | RealtimeJobFailedEvent | RealtimeSiteAddedEvent | RealtimeSiteRemovedEvent | RealtimeAuthFailedEvent | RealtimeNeedsReauthEvent | RealtimeEnrichmentCompleteEvent | RealtimeSitemapProgressEvent | RealtimeSitemapCompleteEvent | RealtimeIndexingProgressEvent | RealtimeIndexingCompleteEvent;
-interface RealtimeAuthRequiredMessage {
-  event: 'auth.required';
-  message: string;
-}
-interface RealtimeConnectedMessage {
-  event: 'connected';
-  partnerId?: string;
-  userId?: number;
-  message: string;
-}
-interface RealtimeSubscribedMessage {
-  type: 'subscribed';
-  siteIds?: string[];
-  partnerIds?: string[];
-}
-interface RealtimePongMessage {
-  type: 'pong';
-  timestamp: number;
-}
-interface RealtimeErrorMessage {
-  type: 'error';
-  message: string;
-}
-type PartnerRealtimeMessage = PartnerRealtimeEvent | RealtimeAuthRequiredMessage | RealtimeConnectedMessage | RealtimeSubscribedMessage | RealtimePongMessage | RealtimeErrorMessage;
 type CanonicalWebhookEventType = 'user.lifecycle.changed' | 'site.lifecycle.changed' | 'site.analytics.ready' | 'site.indexing.ready' | 'site.auth.failed' | 'job.failed';
 type WebhookEventType = CanonicalWebhookEventType;
 interface WebhookEnvelope<TData extends Record<string, unknown> = Record<string, unknown>> {
@@ -1755,4 +1634,4 @@ interface PartnerWebhookHeaders {
   timestamp?: string | null;
   signature?: string | null;
 }
-export { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, FileResolutionRequest, FileResolutionResponse, FileResolutionTable, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, PartnerRealtimeEvent, PartnerRealtimeEventType, PartnerRealtimeMessage, PartnerWebhookData, PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, RealtimeAuthFailedEvent, RealtimeAuthRequiredMessage, RealtimeConnectedMessage, RealtimeEnrichmentCompleteEvent, RealtimeErrorMessage, RealtimeIndexingCompleteEvent, RealtimeIndexingProgressEvent, RealtimeJobFailedEvent, RealtimeNeedsReauthEvent, RealtimePongMessage, RealtimeSiteAddedEvent, RealtimeSiteRemovedEvent, RealtimeSitemapCompleteEvent, RealtimeSitemapProgressEvent, RealtimeSubscribedMessage, RealtimeSyncCompleteEvent, RealtimeSyncFailedEvent, RealtimeSyncJobCompleteEvent, RealtimeSyncProgressEvent, RealtimeSyncSiteCompleteEvent, RegisterPartnerSiteParams, RegisterPartnerUserParams, ResolvedParquetFile, ResolvedTable, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SearchTypeOptions, ServerTailDirective, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapNextAction, SitemapRemovedRow, SitemapStatus, SourceInfoOptions, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, WebhookEnvelope, WebhookEventType, WhoamiResponse, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingNextActions, indexingStatuses, lifecycleErrorCodes, lifecycleWebhookEvents, parseGrantedScopes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses };
+export { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, FileResolutionRequest, FileResolutionResponse, FileResolutionTable, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, Grain, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchType, GscdumpAnalysisBundleParams, GscdumpAnalysisBundleResponse, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, PartnerWebhookData, PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, RegisterPartnerSiteParams, RegisterPartnerUserParams, ResolvedParquetFile, ResolvedTable, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SearchTypeOptions, ServerTailDirective, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapNextAction, SitemapRemovedRow, SitemapStatus, SourceInfoOptions, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, WebhookEnvelope, WebhookEventType, WhoamiResponse, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingNextActions, indexingStatuses, lifecycleErrorCodes, lifecycleWebhookEvents, parseGrantedScopes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses };