@gscdump/contracts 2.0.6 → 2.1.0

package/dist/v1/operations.d.mts

@@ -1841,36 +1841,6 @@ declare function createGscdumpV1Protocol(): {
         readonly version: z.ZodLiteral<"1.0">;
       }, z.core.$strip>;
     }, z.core.$strip>>;
-    keywordEnrichmentRequest: z.ZodObject<{
-      keywords: z.ZodArray<z.ZodString>;
-    }, z.core.$strict>;
-    keywordEnrichmentResponse: CompatibleResponseSchema<z.ZodObject<{
-      data: z.ZodObject<{
-        readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
-          difficulty: z.ZodNullable<z.ZodNumber>;
-          searchVolume: z.ZodNullable<z.ZodNumber>;
-          cpc: z.ZodNullable<z.ZodNumber>;
-        }, z.core.$loose>>;
-      }, z.core.$strip>;
-      meta: z.ZodObject<{
-        readonly requestId: z.ZodString;
-        readonly surface: z.ZodLiteral<"partner">;
-        readonly version: z.ZodLiteral<"1.0">;
-      }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-      data: z.ZodObject<{
-        readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
-          difficulty: z.ZodNullable<z.ZodNumber>;
-          searchVolume: z.ZodNullable<z.ZodNumber>;
-          cpc: z.ZodNullable<z.ZodNumber>;
-        }, z.core.$loose>>;
-      }, z.core.$strip>;
-      meta: z.ZodObject<{
-        readonly requestId: z.ZodString;
-        readonly surface: z.ZodLiteral<"partner">;
-        readonly version: z.ZodLiteral<"1.0">;
-      }, z.core.$strip>;
-    }, z.core.$strip>>;
     lifecycleResponse: CompatibleResponseSchema<z.ZodObject<{
       data: z.ZodObject<{
         readonly userId: z.ZodString;
@@ -11578,275 +11548,6 @@ declare function createGscdumpV1Protocol(): {
           };
         };
       };
-      readonly queryCrossSource: {
-        readonly id: "partner.sites.cross.source.query";
-        readonly method: "POST";
-        readonly path: "/sites/{siteId}/cross-source";
-        readonly visibility: "public";
-        readonly semantics: {
-          readonly kind: "query";
-          readonly sideEffects: "none";
-          readonly idempotent: true;
-          readonly retry: "idempotent";
-          readonly readConsistency: "primary";
-        };
-        readonly auth: {
-          readonly credentials: readonly ["partner_key"];
-          readonly scopes: readonly ["analytics:read"];
-          readonly ownership: readonly [{
-            readonly credential: "partner_key";
-            readonly rule: "authorized_site";
-          }];
-        };
-        readonly request: {
-          readonly params: z.ZodObject<{
-            siteId: z.ZodString;
-          }, z.core.$strict>;
-          readonly query: null;
-          readonly headers: z.ZodObject<{
-            'x-request-id': z.ZodOptional<z.ZodString>;
-          }, z.core.$strict>;
-          readonly body: z.ZodObject<{
-            queryKey: z.ZodEnum<{
-              "crawl-error-losing-impressions": "crawl-error-losing-impressions";
-              "declining-clicks-poor-lcp": "declining-clicks-poor-lcp";
-              "striking-distance-slow-pages": "striking-distance-slow-pages";
-              "top-impressions-low-performance": "top-impressions-low-performance";
-            }>;
-            rangeDays: z.ZodOptional<z.ZodNumber>;
-            limit: z.ZodOptional<z.ZodNumber>;
-          }, z.core.$strict>;
-        };
-        readonly responses: {
-          readonly 200: CompatibleResponseSchema<z.ZodObject<{
-            data: z.ZodObject<{
-              readonly reason: z.ZodOptional<z.ZodString>;
-              readonly sources: z.ZodArray<z.ZodString>;
-              readonly rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
-            }, z.core.$strip>;
-            meta: z.ZodObject<{
-              readonly requestId: z.ZodString;
-              readonly surface: z.ZodLiteral<"partner">;
-              readonly version: z.ZodLiteral<"1.0">;
-            }, z.core.$strip>;
-          }, z.core.$strip>, z.ZodObject<{
-            data: z.ZodObject<{
-              readonly reason: z.ZodOptional<z.ZodString>;
-              readonly sources: z.ZodArray<z.ZodString>;
-              readonly rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
-            }, z.core.$strip>;
-            meta: z.ZodObject<{
-              readonly requestId: z.ZodString;
-              readonly surface: z.ZodLiteral<"partner">;
-              readonly version: z.ZodLiteral<"1.0">;
-            }, z.core.$strip>;
-          }, z.core.$strip>>;
-        };
-        readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
-        readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
-          readonly error: z.ZodObject<{
-            code: z.ZodEnum<{
-              internal_error: "internal_error";
-              invalid_request: "invalid_request";
-              unauthorized: "unauthorized";
-              forbidden: "forbidden";
-              site_not_found: "site_not_found";
-              rate_limited: "rate_limited";
-              contract_violation: "contract_violation";
-            }>;
-            message: z.ZodString;
-            requestId: z.ZodString;
-            retryable: z.ZodBoolean;
-            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
-          }, z.core.$strict>;
-        }, z.core.$strip>, z.ZodObject<{
-          readonly error: z.ZodObject<{
-            code: z.ZodEnum<{
-              internal_error: "internal_error";
-              invalid_request: "invalid_request";
-              unauthorized: "unauthorized";
-              forbidden: "forbidden";
-              site_not_found: "site_not_found";
-              rate_limited: "rate_limited";
-              contract_violation: "contract_violation";
-            }>;
-            message: z.ZodString;
-            requestId: z.ZodString;
-            retryable: z.ZodBoolean;
-            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
-          }, z.core.$loose>;
-        }, z.core.$strip>>;
-        readonly resources: {
-          readonly reads: readonly [{
-            readonly type: "site.analytics";
-            readonly idFrom: "params.siteId";
-          }];
-          readonly changes: readonly [];
-        };
-        readonly lifecycle: {
-          readonly introduced: "1.3.0";
-        };
-        readonly docs: {
-          readonly summary: "Query cross-source analysis";
-          readonly description: "Runs one predefined cross-source query joining crawl, CWV, and GSC signals for a site.";
-          readonly tags: readonly ["Analytics"];
-          readonly examples: {
-            readonly request: {
-              readonly params: {
-                readonly siteId: "s_01";
-              };
-              readonly body: {
-                readonly queryKey: "crawl-error-losing-impressions";
-                readonly rangeDays: 28;
-                readonly limit: 50;
-              };
-            };
-            readonly response: {
-              readonly data: {
-                readonly sources: readonly ["crawl", "gsc"];
-                readonly rows: readonly [];
-              };
-              readonly meta: {
-                readonly requestId: "req_01";
-                readonly surface: "partner";
-                readonly version: "1.0";
-              };
-            };
-          };
-        };
-      };
-      readonly enrichKeywords: {
-        readonly id: "partner.keywords.enrich.query";
-        readonly method: "POST";
-        readonly path: "/keywords/enrich";
-        readonly visibility: "public";
-        readonly semantics: {
-          readonly kind: "query";
-          readonly sideEffects: "none";
-          readonly idempotent: true;
-          readonly retry: "idempotent";
-          readonly readConsistency: "primary";
-        };
-        readonly auth: {
-          readonly credentials: readonly ["user_key", "partner_key"];
-          readonly scopes: readonly ["analytics:read"];
-          readonly ownership: readonly [{
-            readonly credential: "user_key";
-            readonly rule: "self";
-          }, {
-            readonly credential: "partner_key";
-            readonly rule: "partner_tenant";
-          }];
-        };
-        readonly request: {
-          readonly params: null;
-          readonly query: null;
-          readonly headers: z.ZodObject<{
-            'x-request-id': z.ZodOptional<z.ZodString>;
-          }, z.core.$strict>;
-          readonly body: z.ZodObject<{
-            keywords: z.ZodArray<z.ZodString>;
-          }, z.core.$strict>;
-        };
-        readonly responses: {
-          readonly 200: CompatibleResponseSchema<z.ZodObject<{
-            data: z.ZodObject<{
-              readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
-                difficulty: z.ZodNullable<z.ZodNumber>;
-                searchVolume: z.ZodNullable<z.ZodNumber>;
-                cpc: z.ZodNullable<z.ZodNumber>;
-              }, z.core.$loose>>;
-            }, z.core.$strip>;
-            meta: z.ZodObject<{
-              readonly requestId: z.ZodString;
-              readonly surface: z.ZodLiteral<"partner">;
-              readonly version: z.ZodLiteral<"1.0">;
-            }, z.core.$strip>;
-          }, z.core.$strip>, z.ZodObject<{
-            data: z.ZodObject<{
-              readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
-                difficulty: z.ZodNullable<z.ZodNumber>;
-                searchVolume: z.ZodNullable<z.ZodNumber>;
-                cpc: z.ZodNullable<z.ZodNumber>;
-              }, z.core.$loose>>;
-            }, z.core.$strip>;
-            meta: z.ZodObject<{
-              readonly requestId: z.ZodString;
-              readonly surface: z.ZodLiteral<"partner">;
-              readonly version: z.ZodLiteral<"1.0">;
-            }, z.core.$strip>;
-          }, z.core.$strip>>;
-        };
-        readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "rate_limited", "internal_error", "contract_violation"];
-        readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
-          readonly error: z.ZodObject<{
-            code: z.ZodEnum<{
-              internal_error: "internal_error";
-              invalid_request: "invalid_request";
-              unauthorized: "unauthorized";
-              forbidden: "forbidden";
-              user_not_found: "user_not_found";
-              rate_limited: "rate_limited";
-              contract_violation: "contract_violation";
-            }>;
-            message: z.ZodString;
-            requestId: z.ZodString;
-            retryable: z.ZodBoolean;
-            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
-          }, z.core.$strict>;
-        }, z.core.$strip>, z.ZodObject<{
-          readonly error: z.ZodObject<{
-            code: z.ZodEnum<{
-              internal_error: "internal_error";
-              invalid_request: "invalid_request";
-              unauthorized: "unauthorized";
-              forbidden: "forbidden";
-              user_not_found: "user_not_found";
-              rate_limited: "rate_limited";
-              contract_violation: "contract_violation";
-            }>;
-            message: z.ZodString;
-            requestId: z.ZodString;
-            retryable: z.ZodBoolean;
-            details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
-          }, z.core.$loose>;
-        }, z.core.$strip>>;
-        readonly resources: {
-          readonly reads: readonly [];
-          readonly changes: readonly [];
-        };
-        readonly lifecycle: {
-          readonly introduced: "1.3.0";
-        };
-        readonly docs: {
-          readonly summary: "Enrich keywords with metrics";
-          readonly description: "Returns difficulty, search volume, and CPC estimates for up to 500 keywords.";
-          readonly tags: readonly ["Analytics"];
-          readonly examples: {
-            readonly request: {
-              readonly body: {
-                readonly keywords: readonly ["nuxt seo"];
-              };
-            };
-            readonly response: {
-              readonly data: {
-                readonly metrics: {
-                  readonly 'nuxt seo': {
-                    readonly difficulty: 40;
-                    readonly searchVolume: 100;
-                    readonly cpc: 1.2;
-                  };
-                };
-              };
-              readonly meta: {
-                readonly requestId: "req_01";
-                readonly surface: "partner";
-                readonly version: "1.0";
-              };
-            };
-          };
-        };
-      };
     }>;
     analytics: HttpV1Surface<{
       readonly queryRows: {

package/dist/v1/operations.mjs

@@ -53,7 +53,7 @@ function createGscdumpV1Protocol() {
 	});
 	const requestHeaders = z.strictObject({ "x-request-id": realtimeSchemas.publicRequestId.optional() });
 	const errorEnvelope = errorEnvelopeSchemas(HTTP_V1_ERROR_CODES, realtimeSchemas.publicRequestId);
-	const { analyticsRowsRequest, analyticsRowsResponse, keywordEnrichmentRequest, keywordEnrichmentResponse, lifecycleResponse } = browserSchemas;
+	const { analyticsRowsRequest, analyticsRowsResponse, lifecycleResponse } = browserSchemas;
 	const dimensions = GSCDUMP_V1_ANALYTICS_DIMENSIONS;
 	const analyticsMeta = defineResponseObject({
 		requestId: realtimeSchemas.publicRequestId,
@@ -562,21 +562,6 @@ function createGscdumpV1Protocol() {
 		verified: z.literal(true),
 		owners: z.array(z.string()).optional()
 	}), partnerResponseMeta);
-	const crossSourceRequest = z.strictObject({
-		queryKey: z.enum([
-			"crawl-error-losing-impressions",
-			"declining-clicks-poor-lcp",
-			"striking-distance-slow-pages",
-			"top-impressions-low-performance"
-		]),
-		rangeDays: z.number().int().positive().max(180).optional(),
-		limit: z.number().int().positive().max(500).optional()
-	});
-	const crossSourceResponse = defineSuccessResponse(defineResponseObject({
-		reason: z.string().optional(),
-		sources: z.array(z.string()),
-		rows: z.array(z.record(z.string(), z.json()))
-	}), partnerResponseMeta);
 	const responseStreamHead = defineResponseObject({
 		streamId: realtimeSchemas.streamId,
 		sequence: realtimeSchemas.sequence
@@ -3869,128 +3854,6 @@ function createGscdumpV1Protocol() {
 						}
 					}
 				}
-			}),
-			queryCrossSource: defineHttpOperation({
-				id: "partner.sites.cross.source.query",
-				method: "POST",
-				path: "/sites/{siteId}/cross-source",
-				visibility: "public",
-				semantics: {
-					kind: "query",
-					sideEffects: "none",
-					idempotent: true,
-					retry: "idempotent",
-					readConsistency: "primary"
-				},
-				auth: {
-					credentials: ["partner_key"],
-					scopes: ["analytics:read"],
-					ownership: [{
-						credential: "partner_key",
-						rule: "authorized_site"
-					}]
-				},
-				request: {
-					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
-					query: null,
-					headers: requestHeaders,
-					body: crossSourceRequest
-				},
-				responses: { 200: crossSourceResponse },
-				errors: partnerSiteErrors,
-				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
-				resources: {
-					reads: [{
-						type: "site.analytics",
-						idFrom: "params.siteId"
-					}],
-					changes: []
-				},
-				lifecycle: { introduced: "1.3.0" },
-				docs: {
-					summary: "Query cross-source analysis",
-					description: "Runs one predefined cross-source query joining crawl, CWV, and GSC signals for a site.",
-					tags: ["Analytics"],
-					examples: {
-						request: {
-							params: { siteId: "s_01" },
-							body: {
-								queryKey: "crawl-error-losing-impressions",
-								rangeDays: 28,
-								limit: 50
-							}
-						},
-						response: {
-							data: {
-								sources: ["crawl", "gsc"],
-								rows: []
-							},
-							meta: {
-								requestId: "req_01",
-								surface: "partner",
-								version: "1.0"
-							}
-						}
-					}
-				}
-			}),
-			enrichKeywords: defineHttpOperation({
-				id: "partner.keywords.enrich.query",
-				method: "POST",
-				path: "/keywords/enrich",
-				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: "self"
-					}, {
-						credential: "partner_key",
-						rule: "partner_tenant"
-					}]
-				},
-				request: {
-					params: null,
-					query: null,
-					headers: requestHeaders,
-					body: keywordEnrichmentRequest
-				},
-				responses: { 200: keywordEnrichmentResponse },
-				errors: partnerUserErrors,
-				errorResponse: errorEnvelopeSchemas(partnerUserErrors, realtimeSchemas.publicRequestId),
-				resources: {
-					reads: [],
-					changes: []
-				},
-				lifecycle: { introduced: "1.3.0" },
-				docs: {
-					summary: "Enrich keywords with metrics",
-					description: "Returns difficulty, search volume, and CPC estimates for up to 500 keywords.",
-					tags: ["Analytics"],
-					examples: {
-						request: { body: { keywords: ["nuxt seo"] } },
-						response: {
-							data: { metrics: { "nuxt seo": {
-								difficulty: 40,
-								searchVolume: 100,
-								cpc: 1.2
-							} } },
-							meta: {
-								requestId: "req_01",
-								surface: "partner",
-								version: "1.0"
-							}
-						}
-					}
-				}
 			})
 		}
 	});
@@ -4405,8 +4268,6 @@ function createGscdumpV1Protocol() {
 			indexingTransitionsResponse,
 			indexingUrlsQuery,
 			indexingUrlsResponse,
-			keywordEnrichmentRequest,
-			keywordEnrichmentResponse,
 			lifecycleResponse,
 			registerSiteRequest,
 			sitemapChangesQuery,

package/package.json

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