@gscdump/contracts 4.8.0 → 5.1.0

package/dist/v1/operations.mjs

@@ -8,6 +8,7 @@ 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";
 import { GSCDUMP_V1_ANALYTICS_DIMENSIONS, createGscdumpV1BrowserSchemas } from "./browser.mjs";
+import { googleSubmissionReceiptV1Schemas, googleSubmitV1Schema, indexingApiGrantUpdateV1Schema, indexingApiGrantV1Schemas } from "./google-indexing.mjs";
 import { indexNowConfigureV1Schema, indexNowConnectionV1Schemas, indexNowSubmissionReceiptV1Schemas, indexNowSubmitV1Schema } from "./indexnow.mjs";
 import { gscdumpV1OperationRoute, gscdumpV1Surface } from "./route-catalog.mjs";
 import { sitemapSubmissionV1Schemas, sitemapSubmitResultV1Schemas } from "./sitemap-submission.mjs";
@@ -273,6 +274,15 @@ function createGscdumpV1Protocol() {
 		submissionReceipts: z.array(indexNowSubmissionReceiptV1Schemas.client),
 		pagination: bingIndexingEvidencePagination.client
 	}), partnerResponseMeta);
+	const indexingApiGrantResponse = defineSuccessResponse(indexingApiGrantV1Schemas, partnerResponseMeta);
+	const googleSubmissionResponse = defineSuccessResponse(defineResponseObject({ submissionReceipt: googleSubmissionReceiptV1Schemas.producer }, { submissionReceipt: googleSubmissionReceiptV1Schemas.client }), partnerResponseMeta);
+	const googleSubmissionReceiptsResponse = defineSuccessResponse(defineResponseObject({
+		submissionReceipts: z.array(googleSubmissionReceiptV1Schemas.producer),
+		pagination: bingIndexingEvidencePagination.producer
+	}, {
+		submissionReceipts: z.array(googleSubmissionReceiptV1Schemas.client),
+		pagination: bingIndexingEvidencePagination.client
+	}), partnerResponseMeta);
 	const bingSitesResponse = defineSuccessResponse(bingSitesV1Schemas, partnerResponseMeta);
 	const bingLinkResponse = defineSuccessResponse(bingLinkResultV1Schemas, partnerResponseMeta);
 	const bingAuthorizationResponse = defineSuccessResponse(bingAuthorizationV1Schemas, partnerResponseMeta);
@@ -1845,6 +1855,321 @@ function createGscdumpV1Protocol() {
 					}
 				}
 			}),
+			getUserIndexingApiGrant: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.users.indexing.google.grant.get"),
+				visibility: "public",
+				semantics: {
+					kind: "query",
+					sideEffects: "none",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: "primary"
+				},
+				auth: {
+					credentials: ["partner_key"],
+					scopes: ["indexing:read"],
+					ownership: [{
+						credential: "partner_key",
+						rule: "linked_user"
+					}]
+				},
+				request: {
+					params: z.strictObject({ userId: realtimeSchemas.publicUserId }),
+					query: null,
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: indexingApiGrantResponse },
+				errors: partnerUserErrors,
+				errorResponse: errorEnvelopeSchemas(partnerUserErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "partner.user",
+						idFrom: "params.userId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "5.1.0" },
+				docs: {
+					summary: "Get Indexing API grant",
+					description: "Returns the user's Google Indexing API grant for the calling partner.",
+					tags: ["Indexing"],
+					examples: {
+						request: { params: { userId: "u_01" } },
+						response: {
+							data: { _tag: "missing" },
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			updateUserIndexingApiGrant: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.users.indexing.google.grant.update"),
+				visibility: "public",
+				semantics: {
+					kind: "mutation",
+					sideEffects: "state",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: null
+				},
+				auth: {
+					credentials: ["partner_key"],
+					scopes: ["indexing:write"],
+					ownership: [{
+						credential: "partner_key",
+						rule: "linked_user"
+					}]
+				},
+				request: {
+					params: z.strictObject({ userId: realtimeSchemas.publicUserId }),
+					query: null,
+					headers: requestHeaders,
+					body: indexingApiGrantUpdateV1Schema
+				},
+				responses: { 200: indexingApiGrantResponse },
+				errors: partnerUserErrors,
+				errorResponse: errorEnvelopeSchemas(partnerUserErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "partner.user",
+						idFrom: "params.userId"
+					}],
+					changes: [{
+						type: "partner.user",
+						idFrom: "params.userId"
+					}]
+				},
+				lifecycle: { introduced: "5.1.0" },
+				docs: {
+					summary: "Store Indexing API grant",
+					description: "Stores the Google Indexing API grant that the partner obtained with its dedicated Cloud project. A grant without the Indexing API scope is refused.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { userId: "u_01" },
+							body: {
+								refreshToken: "refresh",
+								scope: "openid email https://www.googleapis.com/auth/indexing",
+								googleEmail: "owner@example.com"
+							}
+						},
+						response: {
+							data: {
+								_tag: "granted",
+								googleEmail: "owner@example.com",
+								grantedAt: "2026-10-01T00:00:00.000Z"
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			revokeUserIndexingApiGrant: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.users.indexing.google.grant.revoke"),
+				visibility: "public",
+				semantics: {
+					kind: "mutation",
+					sideEffects: "state",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: null
+				},
+				auth: {
+					credentials: ["partner_key"],
+					scopes: ["indexing:write"],
+					ownership: [{
+						credential: "partner_key",
+						rule: "linked_user"
+					}]
+				},
+				request: {
+					params: z.strictObject({ userId: realtimeSchemas.publicUserId }),
+					query: null,
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: indexingApiGrantResponse },
+				errors: partnerUserErrors,
+				errorResponse: errorEnvelopeSchemas(partnerUserErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "partner.user",
+						idFrom: "params.userId"
+					}],
+					changes: [{
+						type: "partner.user",
+						idFrom: "params.userId"
+					}]
+				},
+				lifecycle: { introduced: "5.1.0" },
+				docs: {
+					summary: "Revoke Indexing API grant",
+					description: "Revokes the grant at Google, then deletes it.",
+					tags: ["Indexing"],
+					examples: {
+						request: { params: { userId: "u_01" } },
+						response: {
+							data: { _tag: "missing" },
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			createSiteGoogleSubmission: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.google.submissions.create"),
+				visibility: "public",
+				semantics: {
+					kind: "mutation",
+					sideEffects: "state",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: null
+				},
+				auth: {
+					credentials: ["partner_key"],
+					scopes: ["indexing:write"],
+					ownership: [{
+						credential: "partner_key",
+						rule: "authorized_site"
+					}]
+				},
+				request: {
+					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
+					query: null,
+					headers: requestHeaders,
+					body: googleSubmitV1Schema
+				},
+				responses: { 200: googleSubmissionResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}]
+				},
+				lifecycle: { introduced: "5.1.0" },
+				docs: {
+					summary: "Submit a Google Indexing API notification",
+					description: "Sends one URL_UPDATED notification for one URL with the Site user's Indexing API grant and returns a Submission Receipt. Acceptance does not prove indexing.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							body: {
+								url: "https://example.com/jobs/1",
+								idempotencyKey: "req_01"
+							}
+						},
+						response: {
+							data: { submissionReceipt: {
+								_tag: "accepted",
+								id: "gi_01",
+								url: "https://example.com/jobs/1",
+								createdAt: "2026-10-01T00:00:00.000Z",
+								updatedAt: "2026-10-01T00:00:00.000Z",
+								attempts: 1,
+								httpStatus: 200,
+								reason: null
+							} },
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			listSiteGoogleSubmissionReceipts: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.google.submissions.list"),
+				visibility: "public",
+				semantics: {
+					kind: "query",
+					sideEffects: "none",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: "primary"
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["indexing:read"],
+					ownership: [{
+						credential: "user_key",
+						rule: "authorized_site"
+					}, {
+						credential: "partner_key",
+						rule: "authorized_site"
+					}]
+				},
+				request: {
+					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
+					query: z.strictObject({
+						limit: z.coerce.number().int().min(1).max(100).default(25),
+						offset: z.coerce.number().int().min(0).default(0)
+					}),
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: googleSubmissionReceiptsResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "5.1.0" },
+				docs: {
+					summary: "List Google Indexing API Submission Receipts",
+					description: "Returns Google Indexing API Submission Receipts for this Site, newest first.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							query: {
+								limit: 25,
+								offset: 0
+							}
+						},
+						response: {
+							data: {
+								submissionReceipts: [],
+								pagination: {
+									total: 0,
+									limit: 25,
+									offset: 0,
+									hasMore: false
+								}
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
 			listUserBingSites: defineHttpOperation({
 				...gscdumpV1OperationRoute("partner.users.indexing.bing.sites.list"),
 				visibility: "public",
@@ -5810,6 +6135,9 @@ function createGscdumpV1Protocol() {
 			indexNowConnectionResponse,
 			indexNowSubmissionResponse,
 			indexNowSubmissionReceiptsResponse,
+			indexingApiGrantResponse,
+			googleSubmissionResponse,
+			googleSubmissionReceiptsResponse,
 			bingSitesResponse,
 			bingLinkResponse,
 			bingAuthorizationResponse,

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

@@ -96,6 +96,31 @@ export declare const GSCDUMP_V1_ROUTE_CATALOG: {
       readonly method: "GET";
       readonly template: "/sites/{siteId}/indexing/indexnow/submissions";
     };
+    readonly 'partner.sites.indexing.google.submissions.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/google/submissions";
+    };
+    readonly 'partner.sites.indexing.google.submissions.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing/google/submissions";
+    };
+    readonly 'partner.users.indexing.google.grant.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/users/{userId}/indexing/google/grant";
+    };
+    readonly 'partner.users.indexing.google.grant.update': {
+      readonly surface: "partner";
+      readonly method: "PATCH";
+      readonly template: "/users/{userId}/indexing/google/grant";
+    };
+    readonly 'partner.users.indexing.google.grant.revoke': {
+      readonly surface: "partner";
+      readonly method: "DELETE";
+      readonly template: "/users/{userId}/indexing/google/grant";
+    };
     readonly 'partner.sites.indexing.bing.connection.get': {
       readonly surface: "partner";
       readonly method: "GET";

package/dist/v1/route-catalog.mjs

@@ -83,6 +83,31 @@ const GSCDUMP_V1_ROUTE_CATALOG = {
 			method: "GET",
 			template: "/sites/{siteId}/indexing/indexnow/submissions"
 		},
+		"partner.sites.indexing.google.submissions.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/google/submissions"
+		},
+		"partner.sites.indexing.google.submissions.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing/google/submissions"
+		},
+		"partner.users.indexing.google.grant.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/users/{userId}/indexing/google/grant"
+		},
+		"partner.users.indexing.google.grant.update": {
+			surface: "partner",
+			method: "PATCH",
+			template: "/users/{userId}/indexing/google/grant"
+		},
+		"partner.users.indexing.google.grant.revoke": {
+			surface: "partner",
+			method: "DELETE",
+			template: "/users/{userId}/indexing/google/grant"
+		},
 		"partner.sites.indexing.bing.connection.get": {
 			surface: "partner",
 			method: "GET",

package/package.json

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