@gscdump/contracts 5.2.0 → 5.5.0

package/dist/v1/operations.mjs

@@ -1,9 +1,10 @@
 import { siteHoldReasonSchema } from "../entitlements.mjs";
 import { watchedUrlsChangeRequestSchema, watchedUrlsChangeResponseSchema, watchedUrlsResponseSchema } from "../indexing-coverage.mjs";
 import { addPartnerTeamMemberSchema, bindPartnerSiteTeamSchema, bindPartnerTeamCatalogResponseSchema, bindPartnerTeamCatalogSchema, builderStateSchema, createPartnerTeamSchema, gscComparisonFilterSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingTransitionFieldSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpPageTrendResponseSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapExportQuerySchema, gscdumpSitemapExportResponseSchema, gscdumpSitemapMembershipParamsSchema, gscdumpSitemapMembershipResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, gscdumpSitemapsResponseSchema, gscdumpTeamRoleSchema, gscdumpTopAssociationResponseSchema, gscdumpUserRegistrationSchema, indexingUrlsResponseSchema, partnerSiteTeamBindingResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, partnerTeamCreatedResponseSchema, partnerTeamDeletedResponseSchema, partnerTeamMemberAddedResponseSchema, partnerTeamMemberRemovedResponseSchema, partnerTeamMemberRoleResponseSchema, partnerTeamMembersResponseSchema, partnerTeamRenamedResponseSchema, registerPartnerSiteSchema, registerPartnerUserSchema, renamePartnerTeamSchema, searchTypeSchema, siteIntIdCrosswalkResponseSchema, sitemapChangesTruncationReasonSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema } from "../schemas.mjs";
-import { bingConnectionV1Schemas } from "./bing.mjs";
 import "./version.mjs";
 import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.mjs";
+import { analyticsCoverageQueryV1Schema, analyticsCoverageV1Schemas } from "./analytics-coverage.mjs";
+import { bingConnectionV1Schemas } from "./bing.mjs";
 import { bingDataQueryV1Schema, bingDataV1Schemas } from "./bing-data.mjs";
 import { bingAuthorizationRequestV1Schema, bingAuthorizationV1Schemas, bingLinkResultV1Schemas, bingSitemapSubmitRequestV1Schema, bingSitemapSubmitResultV1Schemas, bingSitesQueryV1Schema, bingSitesV1Schemas } from "./bing-sites.mjs";
 import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, REALTIME_V1_EVENT_SEMANTICS, createRealtimeV1Schemas } from "./realtime.mjs";
@@ -1209,6 +1210,76 @@ function createGscdumpV1Protocol() {
 					}
 				}
 			}),
+			getSiteAnalyticsCoverage: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.analytics.coverage.get"),
+				visibility: "public",
+				semantics: {
+					kind: "query",
+					sideEffects: "none",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: "primary"
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["analytics:read"],
+					ownership: [{
+						credential: "user_key",
+						rule: "authorized_site"
+					}, {
+						credential: "partner_key",
+						rule: "authorized_site"
+					}]
+				},
+				request: {
+					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
+					query: analyticsCoverageQueryV1Schema,
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: defineSuccessResponse(analyticsCoverageV1Schemas, partnerResponseMeta) },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.analytics",
+						idFrom: "params.siteId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "5.5.0" },
+				docs: {
+					summary: "Get recorded analytics coverage",
+					description: "Checks continuous recorded coverage for the current and comparison windows. Successful zero-row days count. Missing days prevent completeness.",
+					tags: ["Analytics"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							query: {
+								startDate: "2026-10-01",
+								endDate: "2026-10-02",
+								searchType: "web"
+							}
+						},
+						response: {
+							data: {
+								searchType: "web",
+								current: {
+									startDate: "2026-10-01",
+									endDate: "2026-10-02",
+									complete: true
+								},
+								comparison: null
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
 			getSiteIndexing: defineHttpOperation({
 				...gscdumpV1OperationRoute("partner.sites.indexing.get"),
 				visibility: "public",
@@ -2755,7 +2826,7 @@ function createGscdumpV1Protocol() {
 				lifecycle: { introduced: "1.0.0" },
 				docs: {
 					summary: "Get sitemap snapshot",
-					description: "Returns registered sitemaps and their aggregate and per-sitemap history.",
+					description: "Returns registered sitemaps and their aggregate and per-sitemap history. Each Sitemap's `feed` says whether it counts toward the next Generation. A Sitemap that answered 404 or 410 for 3 UTC days is `dropped`.",
 					tags: ["Sitemaps"],
 					examples: {
 						request: { params: { siteId: "s_01" } },
@@ -5374,7 +5445,7 @@ function createGscdumpV1Protocol() {
 				lifecycle: { introduced: "1.3.0" },
 				docs: {
 					summary: "Delete a partner user",
-					description: "Queues cascade deletion of a partner-linked user and their sites.",
+					description: "Queues removal of the calling partner's part of a linked user: its Sites, Usage pool, credential, and issued API keys. gscdump deletes the user only when nothing outside the partner holds them. `searchConsoleGrant` reports what happened to the Search Console grant that the partner's own OAuth client issued.",
 					tags: ["Users"],
 					examples: {
 						request: { params: { userId: "u_01" } },
@@ -5383,7 +5454,8 @@ function createGscdumpV1Protocol() {
 								ok: true,
 								queued: true,
 								userId: 1,
-								publicId: "u_01"
+								publicId: "u_01",
+								searchConsoleGrant: { _tag: "revoked" }
 							},
 							meta: {
 								requestId: "req_01",

package/dist/v1/route-catalog.d.mts

@@ -16,6 +16,11 @@ export declare const GSCDUMP_V1_ROUTE_CATALOG: {
     };
   };
   readonly operations: {
+    readonly 'partner.sites.analytics.coverage.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/analytics/coverage";
+    };
     readonly 'partner.users.lifecycle.get': {
       readonly surface: "partner";
       readonly method: "GET";

package/dist/v1/route-catalog.mjs

@@ -3,6 +3,11 @@ import { GSCDUMP_V1_ROUTE_SURFACES } from "./route-surfaces.mjs";
 const GSCDUMP_V1_ROUTE_CATALOG = {
 	surfaces: GSCDUMP_V1_ROUTE_SURFACES,
 	operations: {
+		"partner.sites.analytics.coverage.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/analytics/coverage"
+		},
 		"partner.users.lifecycle.get": {
 			surface: "partner",
 			method: "GET",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/contracts",
   "type": "module",
-  "version": "5.2.0",
+  "version": "5.5.0",
   "description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
   "author": {
     "name": "Harlan Wilton",