@gscdump/contracts 4.7.0 → 5.0.0

package/dist/v1/operations.mjs

@@ -5,10 +5,12 @@ import { bingConnectionV1Schemas } from "./bing.mjs";
 import "./version.mjs";
 import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.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";
 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 { sitemapSubmissionV1Schemas, sitemapSubmitResultV1Schemas } from "./sitemap-submission.mjs";
 import { z } from "zod";
 function errorEnvelopeSchemas(codes, publicRequestId) {
 	const errorDetails = z.record(z.string(), z.json());
@@ -271,6 +273,12 @@ function createGscdumpV1Protocol() {
 		submissionReceipts: z.array(indexNowSubmissionReceiptV1Schemas.client),
 		pagination: bingIndexingEvidencePagination.client
 	}), partnerResponseMeta);
+	const bingSitesResponse = defineSuccessResponse(bingSitesV1Schemas, partnerResponseMeta);
+	const bingLinkResponse = defineSuccessResponse(bingLinkResultV1Schemas, partnerResponseMeta);
+	const bingAuthorizationResponse = defineSuccessResponse(bingAuthorizationV1Schemas, partnerResponseMeta);
+	const bingSitemapSubmitResponse = defineSuccessResponse(bingSitemapSubmitResultV1Schemas, partnerResponseMeta);
+	const sitemapSubmissionResponse = defineSuccessResponse(sitemapSubmissionV1Schemas, partnerResponseMeta);
+	const sitemapSubmitResponse = defineSuccessResponse(sitemapSubmitResultV1Schemas, partnerResponseMeta);
 	const indexingTransition = defineResponseObject({
 		url: z.string(),
 		field: gscdumpIndexingTransitionFieldSchema,
@@ -1837,6 +1845,274 @@ function createGscdumpV1Protocol() {
 					}
 				}
 			}),
+			listUserBingSites: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.users.indexing.bing.sites.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: "self"
+					}, {
+						credential: "partner_key",
+						rule: "linked_user"
+					}]
+				},
+				request: {
+					params: z.strictObject({ userId: realtimeSchemas.publicUserId }),
+					query: bingSitesQueryV1Schema,
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: bingSitesResponse },
+				errors: partnerUserErrors,
+				errorResponse: errorEnvelopeSchemas(partnerUserErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "partner.user",
+						idFrom: "params.userId"
+					}, {
+						type: "user.sites",
+						idFrom: "params.userId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "4.8.0" },
+				docs: {
+					summary: "List Bing state for every Site",
+					description: "Returns the user's Bing grant and one tagged Bing state for each Site the user can see. A partner credential sees only its own Sites. `callerCanAct` says whether the caller may run the Operation the state names. Filter by `teamId` to read one Team.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { userId: "u_01" },
+							query: { teamId: "t_01" }
+						},
+						response: {
+							data: {
+								searchEngine: "bing",
+								grant: {
+									_tag: "authorized",
+									scopes: ["webmaster.manage"]
+								},
+								sites: [{
+									siteId: "s_01",
+									siteUrl: "https://example.com/",
+									teamId: "t_01",
+									callerCanAct: true,
+									state: {
+										_tag: "linkable",
+										reason: "not-linked"
+									}
+								}]
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			linkSiteBing: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.bing.link.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: null
+				},
+				responses: { 200: bingLinkResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}]
+				},
+				lifecycle: { introduced: "4.8.0" },
+				docs: {
+					summary: "Link a Site to Bing",
+					description: "Binds the Site with the Site owner's stored Bing grant, with no Microsoft redirect. Only the Site owner's user credential may link: any other caller gets `403 forbidden` with `details.reason` `site-owner-required`. Every expected outcome is a value: `linked` carries the new Site state, `grant-required` asks the owner to authorize Bing, and `failed` says whether a retry can help.",
+					tags: ["Indexing"],
+					examples: {
+						request: { params: { siteId: "s_01" } },
+						response: {
+							data: {
+								_tag: "grant-required",
+								reason: "grant-missing"
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			createSiteBingAuthorization: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.bing.authorization.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: bingAuthorizationRequestV1Schema
+				},
+				responses: { 200: bingAuthorizationResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "4.8.0" },
+				docs: {
+					summary: "Authorize Bing for a Site",
+					description: "Returns a Microsoft authorize URL that expires at `expiresAt`. After consent, gscdump stores the grant, links the Site, and returns the browser to `returnUrl` with `bing=connected`, `bing=verification-required`, or `bing=error&reason=<reason>`. `returnUrl` must be a gscdump.com path or an allowed origin, otherwise the request fails with `400 invalid_request` and `details.reason` `return-url-not-allowed`. Only the Site owner's user credential may authorize.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							body: { returnUrl: "https://nuxtseo.com/pro/dashboard/integrations" }
+						},
+						response: {
+							data: {
+								authorizeUrl: "https://www.bing.com/webmasters/oauth/authorize?client_id=gscdump&state=intent_01",
+								expiresAt: "2026-09-30T00:10:00.000Z"
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			submitSiteBingSitemap: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.indexing.bing.sitemaps.submit"),
+				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: bingSitemapSubmitRequestV1Schema
+				},
+				responses: { 200: bingSitemapSubmitResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}],
+					changes: [{
+						type: "site.indexing",
+						idFrom: "params.siteId"
+					}]
+				},
+				lifecycle: { introduced: "4.8.0" },
+				docs: {
+					summary: "Submit a Sitemap to Bing",
+					description: "Submits one Sitemap for a verified Site, then reads what Bing lists. Without `url`, gscdump submits the Sitemap it finds on the Site. Bing lags after a submit, so `sitemap` usually reads `awaiting-bing`. Every expected outcome is a value.",
+					tags: ["Indexing"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							body: {}
+						},
+						response: {
+							data: {
+								_tag: "submitted",
+								sitemapUrl: "https://example.com/sitemap.xml",
+								sitemap: {
+									_tag: "awaiting-bing",
+									checkedAt: "2026-09-30T00:00:00.000Z",
+									lastSubmittedAt: "2026-09-30T00:00:00.000Z"
+								}
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
 			getSiteBingConnection: defineHttpOperation({
 				...gscdumpV1OperationRoute("partner.sites.indexing.bing.connection.get"),
 				visibility: "public",
@@ -2183,6 +2459,132 @@ function createGscdumpV1Protocol() {
 					}
 				}
 			}),
+			getSiteSitemapSubmission: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.sitemaps.submission.get"),
+				visibility: "public",
+				semantics: {
+					kind: "query",
+					sideEffects: "none",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: "primary"
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["sitemaps: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: sitemapSubmissionResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.sitemaps",
+						idFrom: "params.siteId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "4.8.0" },
+				docs: {
+					summary: "Get Sitemap submission",
+					description: "Returns the Sitemap gscdump would submit to Google for the Site and whether the stored grant can submit it. gscdump picks a Sitemap it found on the Site's own host, under the linked property, and reads its own record of the granted scopes and the property permission. It makes no Google call.",
+					tags: ["Sitemaps"],
+					examples: {
+						request: { params: { siteId: "s_01" } },
+						response: {
+							data: {
+								searchEngine: "google",
+								gscPropertyUrl: "sc-domain:example.com",
+								callerCanAct: true,
+								state: {
+									_tag: "ready",
+									sitemapUrl: "https://example.com/sitemap.xml",
+									writeAccess: "granted"
+								}
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
+			submitSiteSitemap: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.sitemaps.submission.create"),
+				visibility: "public",
+				semantics: {
+					kind: "mutation",
+					sideEffects: "state",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: null
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["sitemaps: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: sitemapSubmitResponse },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.sitemaps",
+						idFrom: "params.siteId"
+					}],
+					changes: [{
+						type: "site.sitemaps",
+						idFrom: "params.siteId"
+					}]
+				},
+				lifecycle: { introduced: "4.8.0" },
+				docs: {
+					summary: "Submit a Sitemap to Google",
+					description: "Submits the Sitemap `partner.sites.sitemaps.submission.get` names, with the Site owner's stored grant. It reads Google's Sitemap list first, so a Sitemap submitted elsewhere reads `already-listed`. When gscdump has found none yet, it looks on the Site. It does not ask Google to submit when its own record shows the grant or permission cannot. Every expected outcome is a value.",
+					tags: ["Sitemaps"],
+					examples: {
+						request: { params: { siteId: "s_01" } },
+						response: {
+							data: {
+								_tag: "submitted",
+								sitemapUrl: "https://example.com/sitemap.xml",
+								sitemapCount: 1
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
 			getSiteSitemapChanges: defineHttpOperation({
 				...gscdumpV1OperationRoute("partner.sites.sitemaps.changes.get"),
 				visibility: "public",
@@ -5408,6 +5810,12 @@ function createGscdumpV1Protocol() {
 			indexNowConnectionResponse,
 			indexNowSubmissionResponse,
 			indexNowSubmissionReceiptsResponse,
+			bingSitesResponse,
+			bingLinkResponse,
+			bingAuthorizationResponse,
+			bingSitemapSubmitResponse,
+			sitemapSubmissionResponse,
+			sitemapSubmitResponse,
 			lifecycleResponse,
 			userEntitlementsResponse,
 			registerSiteRequest,

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

@@ -46,6 +46,11 @@ export declare const GSCDUMP_V1_ROUTE_CATALOG: {
       readonly method: "PATCH";
       readonly template: "/users/{userId}/tokens";
     };
+    readonly 'partner.users.indexing.bing.sites.list': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/users/{userId}/indexing/bing/sites";
+    };
     readonly 'partner.sites.indexing.get': {
       readonly surface: "partner";
       readonly method: "GET";
@@ -101,6 +106,21 @@ export declare const GSCDUMP_V1_ROUTE_CATALOG: {
       readonly method: "POST";
       readonly template: "/sites/{siteId}/indexing/bing/connection/verify";
     };
+    readonly 'partner.sites.indexing.bing.link.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/bing/link";
+    };
+    readonly 'partner.sites.indexing.bing.authorization.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/bing/authorization";
+    };
+    readonly 'partner.sites.indexing.bing.sitemaps.submit': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/indexing/bing/sitemaps";
+    };
     readonly 'partner.sites.indexing.transitions.list': {
       readonly surface: "partner";
       readonly method: "GET";
@@ -121,6 +141,16 @@ export declare const GSCDUMP_V1_ROUTE_CATALOG: {
       readonly method: "GET";
       readonly template: "/sites/{siteId}/sitemaps/changes";
     };
+    readonly 'partner.sites.sitemaps.submission.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/sitemaps/submission";
+    };
+    readonly 'partner.sites.sitemaps.submission.create': {
+      readonly surface: "partner";
+      readonly method: "POST";
+      readonly template: "/sites/{siteId}/sitemaps/submission";
+    };
     readonly 'partner.sites.analysis.get': {
       readonly surface: "partner";
       readonly method: "GET";

package/dist/v1/route-catalog.mjs

@@ -33,6 +33,11 @@ const GSCDUMP_V1_ROUTE_CATALOG = {
 			method: "PATCH",
 			template: "/users/{userId}/tokens"
 		},
+		"partner.users.indexing.bing.sites.list": {
+			surface: "partner",
+			method: "GET",
+			template: "/users/{userId}/indexing/bing/sites"
+		},
 		"partner.sites.indexing.get": {
 			surface: "partner",
 			method: "GET",
@@ -88,6 +93,21 @@ const GSCDUMP_V1_ROUTE_CATALOG = {
 			method: "POST",
 			template: "/sites/{siteId}/indexing/bing/connection/verify"
 		},
+		"partner.sites.indexing.bing.link.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/bing/link"
+		},
+		"partner.sites.indexing.bing.authorization.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/bing/authorization"
+		},
+		"partner.sites.indexing.bing.sitemaps.submit": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/indexing/bing/sitemaps"
+		},
 		"partner.sites.indexing.transitions.list": {
 			surface: "partner",
 			method: "GET",
@@ -108,6 +128,16 @@ const GSCDUMP_V1_ROUTE_CATALOG = {
 			method: "GET",
 			template: "/sites/{siteId}/sitemaps/changes"
 		},
+		"partner.sites.sitemaps.submission.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/sitemaps/submission"
+		},
+		"partner.sites.sitemaps.submission.create": {
+			surface: "partner",
+			method: "POST",
+			template: "/sites/{siteId}/sitemaps/submission"
+		},
 		"partner.sites.analysis.get": {
 			surface: "partner",
 			method: "GET",