@gscdump/contracts 4.3.0 → 4.5.0

package/dist/v1/operations.mjs

@@ -5,6 +5,7 @@ import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResp
 import { bingDataQueryV1Schema, bingDataV1Schemas } from "./bing-data.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 { indexNowConfigureV1Schema, indexNowConnectionV1Schemas, indexNowSubmissionReceiptV1Schemas, indexNowSubmitV1Schema } from "./indexnow.mjs";
 import { gscdumpV1OperationRoute, gscdumpV1Surface } from "./route-catalog.mjs";
 import { z } from "zod";
 function errorEnvelopeSchemas(codes, publicRequestId) {
@@ -259,6 +260,15 @@ function createGscdumpV1Protocol() {
 		pagination: bingIndexingEvidencePagination.client
 	}), partnerResponseMeta);
 	const bingConnectionResponse = defineSuccessResponse(bingConnectionV1Schemas, partnerResponseMeta);
+	const indexNowConnectionResponse = defineSuccessResponse(indexNowConnectionV1Schemas, partnerResponseMeta);
+	const indexNowSubmissionResponse = defineSuccessResponse(defineResponseObject({ submissionReceipt: indexNowSubmissionReceiptV1Schemas.producer }, { submissionReceipt: indexNowSubmissionReceiptV1Schemas.client }), partnerResponseMeta);
+	const indexNowSubmissionReceiptsResponse = defineSuccessResponse(defineResponseObject({
+		submissionReceipts: z.array(indexNowSubmissionReceiptV1Schemas.producer),
+		pagination: bingIndexingEvidencePagination.producer
+	}, {
+		submissionReceipts: z.array(indexNowSubmissionReceiptV1Schemas.client),
+		pagination: bingIndexingEvidencePagination.client
+	}), partnerResponseMeta);
 	const indexingTransition = defineResponseObject({
 		url: z.string(),
 		field: gscdumpIndexingTransitionFieldSchema,
@@ -1363,6 +1373,339 @@ function createGscdumpV1Protocol() {
 					}
 				}
 			}),
+			getSiteIndexNowConnection: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.indexnow.connection.get"),
+				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: null,
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: indexNowConnectionResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "1.7.0" },
+				docs: {
+					summary: "Get IndexNow connection",
+					description: "Returns the exact Site host and IndexNow key verification state.",
+					tags: ["Indexing"],
+					examples: {
+						request: { params: { siteId: "s_01" } },
+						response: {
+							data: {
+								_tag: "disconnected",
+								host: "example.com"
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			configureSiteIndexNowConnection: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.indexnow.connection.configure"),
+				visibility: "public",
+				semantics: {
+					kind: "mutation",
+					sideEffects: "state",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: null
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["indexing:write"],
+					ownership: [{
+						credential: "user_key",
+						rule: "authorized_site"
+					}, {
+						credential: "partner_key",
+						rule: "authorized_site"
+					}]
+				},
+				request: {
+					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
+					query: null,
+					headers: requestHeaders,
+					body: indexNowConfigureV1Schema
+				},
+				responses: { 200: indexNowConnectionResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}]
+				},
+				lifecycle: { introduced: "1.7.0" },
+				docs: {
+					summary: "Configure IndexNow connection",
+					description: "Stores an IndexNow key and key file location for the Site.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							body: { key: "abc12345" }
+						},
+						response: {
+							data: {
+								_tag: "verification-required",
+								host: "example.com",
+								keyLocation: "https://example.com/abc12345.txt",
+								reason: null
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			verifySiteIndexNowConnection: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.indexnow.connection.verify"),
+				visibility: "public",
+				semantics: {
+					kind: "mutation",
+					sideEffects: "state",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: null
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["indexing:write"],
+					ownership: [{
+						credential: "user_key",
+						rule: "authorized_site"
+					}, {
+						credential: "partner_key",
+						rule: "authorized_site"
+					}]
+				},
+				request: {
+					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
+					query: null,
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: indexNowConnectionResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}]
+				},
+				lifecycle: { introduced: "1.7.0" },
+				docs: {
+					summary: "Verify IndexNow key file",
+					description: "Checks the key file on the exact Site host.",
+					tags: ["Indexing"],
+					examples: {
+						request: { params: { siteId: "s_01" } },
+						response: {
+							data: {
+								_tag: "connected",
+								host: "example.com",
+								keyLocation: "https://example.com/abc12345.txt",
+								verifiedAt: "2026-09-30T00:00:00.000Z"
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			submitSiteIndexNow: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.indexnow.submissions.create"),
+				visibility: "public",
+				semantics: {
+					kind: "mutation",
+					sideEffects: "state",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: null
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["indexing:write"],
+					ownership: [{
+						credential: "user_key",
+						rule: "authorized_site"
+					}, {
+						credential: "partner_key",
+						rule: "authorized_site"
+					}]
+				},
+				request: {
+					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
+					query: null,
+					headers: requestHeaders,
+					body: indexNowSubmitV1Schema
+				},
+				responses: { 200: indexNowSubmissionResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}]
+				},
+				lifecycle: { introduced: "1.7.0" },
+				docs: {
+					summary: "Submit IndexNow change notifications",
+					description: "Queues change notifications and returns a Submission Receipt. Acceptance does not prove indexing.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							body: {
+								urls: ["https://example.com/page"],
+								idempotencyKey: "req_01"
+							}
+						},
+						response: {
+							data: { submissionReceipt: {
+								_tag: "queued",
+								id: "in_01",
+								urls: ["https://example.com/page"],
+								createdAt: "2026-09-30T00:00:00.000Z",
+								updatedAt: "2026-09-30T00:00:00.000Z",
+								attempts: 0,
+								httpStatus: null,
+								reason: null,
+								retryAt: null
+							} },
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			listSiteIndexNowSubmissionReceipts: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.indexnow.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: indexNowSubmissionReceiptsResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "1.7.0" },
+				docs: {
+					summary: "List IndexNow Submission Receipts",
+					description: "Returns Submission Receipts for this Site.",
+					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"
+							}
+						}
+					}
+				}
+			}),
 			getSiteBingConnection: defineHttpOperation({
 				...gscdumpV1OperationRoute("partner.sites.indexing.bing.connection.get"),
 				visibility: "public",
@@ -4724,6 +5067,9 @@ function createGscdumpV1Protocol() {
 			bingIndexingEvidenceQuery,
 			bingIndexingEvidenceResponse,
 			bingConnectionResponse,
+			indexNowConnectionResponse,
+			indexNowSubmissionResponse,
+			indexNowSubmissionReceiptsResponse,
 			lifecycleResponse,
 			registerSiteRequest,
 			sitemapChangesQuery,

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

@@ -61,6 +61,31 @@ export declare const GSCDUMP_V1_ROUTE_CATALOG: {
       readonly method: "GET";
       readonly template: "/sites/{siteId}/indexing/bing/evidence";
     };
+    readonly 'partner.sites.indexing.indexnow.connection.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing/indexnow/connection";
+    };
+    readonly 'partner.sites.indexing.indexnow.connection.configure': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/indexnow/connection";
+    };
+    readonly 'partner.sites.indexing.indexnow.connection.verify': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/indexnow/connection/verify";
+    };
+    readonly 'partner.sites.indexing.indexnow.submissions.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/indexnow/submissions";
+    };
+    readonly 'partner.sites.indexing.indexnow.submissions.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/indexing/indexnow/submissions";
+    };
     readonly 'partner.sites.indexing.bing.connection.get': {
       readonly surface: "partner";
       readonly method: "GET";

package/dist/v1/route-catalog.mjs

@@ -48,6 +48,31 @@ const GSCDUMP_V1_ROUTE_CATALOG = {
 			method: "GET",
 			template: "/sites/{siteId}/indexing/bing/evidence"
 		},
+		"partner.sites.indexing.indexnow.connection.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing/indexnow/connection"
+		},
+		"partner.sites.indexing.indexnow.connection.configure": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/indexnow/connection"
+		},
+		"partner.sites.indexing.indexnow.connection.verify": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/indexnow/connection/verify"
+		},
+		"partner.sites.indexing.indexnow.submissions.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/indexnow/submissions"
+		},
+		"partner.sites.indexing.indexnow.submissions.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/indexing/indexnow/submissions"
+		},
 		"partner.sites.indexing.bing.connection.get": {
 			surface: "partner",
 			method: "GET",

package/package.json

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