@gscdump/contracts 1.4.1 → 1.4.2

package/dist/v1/operations.d.mts

@@ -1,16 +1,6 @@
-import { CompatibleResponseSchema, HttpV1Surface } from "./http.mjs";
+import { CompatibleResponseSchema, HttpV1Surface } from "./http-core.mjs";
+import { NormalizedFilterV1 } from "./browser.mjs";
 import { z } from "zod";
-declare const GSCDUMP_HTTP_V1_VERSION: '1.0';
-interface NormalizedFilterV1 {
-  _filters: Array<{
-    dimension: string;
-    operator: string;
-    expression: string;
-    expression2?: string;
-  }>;
-  _nestedGroups?: NormalizedFilterV1[];
-  _groupType?: 'and' | 'or';
-}
 declare function createGscdumpV1Protocol(): {
   constants: {
     httpVersion: "1.0";
@@ -135,6 +125,25 @@ declare function createGscdumpV1Protocol(): {
       streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
       sequence: z.ZodString;
     }, z.core.$strict>;
+    ticketResponseClient: z.ZodObject<{
+      data: z.ZodObject<{
+        socketUrl: z.ZodURL;
+        protocol: z.ZodLiteral<"gscdump.v1">;
+        protocolVersion: z.ZodLiteral<1>;
+        ticket: z.ZodString;
+        expiresAt: z.ZodISODateTime;
+        head: z.ZodObject<{
+          streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+          sequence: z.ZodString;
+        }, z.core.$loose>;
+        maxConnectionSeconds: z.ZodLiteral<900>;
+      }, z.core.$loose>;
+      meta: z.ZodObject<{
+        requestId: z.ZodString;
+        surface: z.ZodLiteral<"realtime">;
+        version: z.ZodLiteral<"1.0">;
+      }, z.core.$loose>;
+    }, z.core.$loose>;
     ticketRequest: z.ZodObject<{
       origin: z.ZodOptional<z.ZodURL>;
     }, z.core.$strict>;
@@ -2525,43 +2534,46 @@ declare function createGscdumpV1Protocol(): {
         readonly version: z.ZodLiteral<"1.0">;
       }, z.core.$strip>;
     }, z.core.$strip>>;
-    ticketResponse: CompatibleResponseSchema<z.ZodObject<{
-      data: z.ZodObject<{
-        socketUrl: z.ZodURL;
-        protocol: z.ZodLiteral<"gscdump.v1">;
-        protocolVersion: z.ZodLiteral<1>;
-        ticket: z.ZodString;
-        expiresAt: z.ZodISODateTime;
-        head: z.ZodObject<{
-          readonly streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
-          readonly sequence: z.ZodString;
-        }, z.core.$strip>;
-        maxConnectionSeconds: z.ZodLiteral<900>;
-      }, z.core.$strip>;
-      meta: z.ZodObject<{
-        readonly requestId: z.ZodString;
-        readonly surface: z.ZodLiteral<"realtime">;
-        readonly version: z.ZodLiteral<"1.0">;
-      }, z.core.$strip>;
-    }, z.core.$strip>, z.ZodObject<{
-      data: z.ZodObject<{
-        readonly socketUrl: z.ZodURL;
-        readonly protocol: z.ZodLiteral<"gscdump.v1">;
-        readonly protocolVersion: z.ZodLiteral<1>;
-        readonly ticket: z.ZodString;
-        readonly expiresAt: z.ZodISODateTime;
-        readonly maxConnectionSeconds: z.ZodLiteral<900>;
-        readonly head: z.ZodObject<{
-          readonly streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
-          readonly sequence: z.ZodString;
+    ticketResponse: {
+      producer: z.ZodObject<{
+        data: z.ZodObject<{
+          socketUrl: z.ZodURL;
+          protocol: z.ZodLiteral<"gscdump.v1">;
+          protocolVersion: z.ZodLiteral<1>;
+          ticket: z.ZodString;
+          expiresAt: z.ZodISODateTime;
+          head: z.ZodObject<{
+            readonly streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+            readonly sequence: z.ZodString;
+          }, z.core.$strip>;
+          maxConnectionSeconds: z.ZodLiteral<900>;
+        }, z.core.$strict>;
+        meta: z.ZodObject<{
+          readonly requestId: z.ZodString;
+          readonly surface: z.ZodLiteral<"realtime">;
+          readonly version: z.ZodLiteral<"1.0">;
         }, z.core.$strip>;
-      }, z.core.$strip>;
-      meta: z.ZodObject<{
-        readonly requestId: z.ZodString;
-        readonly surface: z.ZodLiteral<"realtime">;
-        readonly version: z.ZodLiteral<"1.0">;
-      }, z.core.$strip>;
-    }, z.core.$strip>>;
+      }, z.core.$strict>;
+      client: z.ZodObject<{
+        data: z.ZodObject<{
+          socketUrl: z.ZodURL;
+          protocol: z.ZodLiteral<"gscdump.v1">;
+          protocolVersion: z.ZodLiteral<1>;
+          ticket: z.ZodString;
+          expiresAt: z.ZodISODateTime;
+          head: z.ZodObject<{
+            streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+            sequence: z.ZodString;
+          }, z.core.$loose>;
+          maxConnectionSeconds: z.ZodLiteral<900>;
+        }, z.core.$loose>;
+        meta: z.ZodObject<{
+          requestId: z.ZodString;
+          surface: z.ZodLiteral<"realtime">;
+          version: z.ZodLiteral<"1.0">;
+        }, z.core.$loose>;
+      }, z.core.$loose>;
+    };
     userRegistrationResponse: CompatibleResponseSchema<z.ZodObject<{
       data: z.ZodObject<{
         userId: z.ZodString;
@@ -11561,43 +11573,46 @@ declare function createGscdumpV1Protocol(): {
           }, z.core.$strict>;
         };
         readonly responses: {
-          201: CompatibleResponseSchema<z.ZodObject<{
-            data: z.ZodObject<{
-              socketUrl: z.ZodURL;
-              protocol: z.ZodLiteral<"gscdump.v1">;
-              protocolVersion: z.ZodLiteral<1>;
-              ticket: z.ZodString;
-              expiresAt: z.ZodISODateTime;
-              head: z.ZodObject<{
-                readonly streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
-                readonly sequence: z.ZodString;
-              }, z.core.$strip>;
-              maxConnectionSeconds: z.ZodLiteral<900>;
-            }, z.core.$strip>;
-            meta: z.ZodObject<{
-              readonly requestId: z.ZodString;
-              readonly surface: z.ZodLiteral<"realtime">;
-              readonly version: z.ZodLiteral<"1.0">;
-            }, z.core.$strip>;
-          }, z.core.$strip>, z.ZodObject<{
-            data: z.ZodObject<{
-              readonly socketUrl: z.ZodURL;
-              readonly protocol: z.ZodLiteral<"gscdump.v1">;
-              readonly protocolVersion: z.ZodLiteral<1>;
-              readonly ticket: z.ZodString;
-              readonly expiresAt: z.ZodISODateTime;
-              readonly maxConnectionSeconds: z.ZodLiteral<900>;
-              readonly head: z.ZodObject<{
-                readonly streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
-                readonly sequence: z.ZodString;
+          201: {
+            producer: z.ZodObject<{
+              data: z.ZodObject<{
+                socketUrl: z.ZodURL;
+                protocol: z.ZodLiteral<"gscdump.v1">;
+                protocolVersion: z.ZodLiteral<1>;
+                ticket: z.ZodString;
+                expiresAt: z.ZodISODateTime;
+                head: z.ZodObject<{
+                  readonly streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                  readonly sequence: z.ZodString;
+                }, z.core.$strip>;
+                maxConnectionSeconds: z.ZodLiteral<900>;
+              }, z.core.$strict>;
+              meta: z.ZodObject<{
+                readonly requestId: z.ZodString;
+                readonly surface: z.ZodLiteral<"realtime">;
+                readonly version: z.ZodLiteral<"1.0">;
               }, z.core.$strip>;
-            }, z.core.$strip>;
-            meta: z.ZodObject<{
-              readonly requestId: z.ZodString;
-              readonly surface: z.ZodLiteral<"realtime">;
-              readonly version: z.ZodLiteral<"1.0">;
-            }, z.core.$strip>;
-          }, z.core.$strip>>;
+            }, z.core.$strict>;
+            client: z.ZodObject<{
+              data: z.ZodObject<{
+                socketUrl: z.ZodURL;
+                protocol: z.ZodLiteral<"gscdump.v1">;
+                protocolVersion: z.ZodLiteral<1>;
+                ticket: z.ZodString;
+                expiresAt: z.ZodISODateTime;
+                head: z.ZodObject<{
+                  streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+                  sequence: z.ZodString;
+                }, z.core.$loose>;
+                maxConnectionSeconds: z.ZodLiteral<900>;
+              }, z.core.$loose>;
+              meta: z.ZodObject<{
+                requestId: z.ZodString;
+                surface: z.ZodLiteral<"realtime">;
+                version: z.ZodLiteral<"1.0">;
+              }, z.core.$loose>;
+            }, z.core.$loose>;
+          };
         };
         readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "rate_limited", "realtime_unavailable", "internal_error", "contract_violation"];
         readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
@@ -11695,5 +11710,4 @@ type PartnerSitemapChangesV1Response = z.infer<GscdumpV1Protocol['schemas']['sit
 type PartnerSiteRegistrationV1Response = z.infer<GscdumpV1Protocol['schemas']['siteRegistrationResponse']['client']>;
 type PartnerSiteDeletionV1Response = z.infer<GscdumpV1Protocol['schemas']['siteDeletionResponse']['client']>;
 type PartnerUserLifecycleV1Response = z.infer<GscdumpV1Protocol['schemas']['lifecycleResponse']['client']>;
-type RealtimeTicketV1Response = z.infer<GscdumpV1Protocol['schemas']['ticketResponse']['client']>;
-export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GSCDUMP_HTTP_V1_VERSION, GscdumpV1ErrorEnvelope, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, RealtimeTicketV1Response, createGscdumpV1Protocol };
+export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol };

package/dist/v1/operations.mjs

@@ -1,9 +1,9 @@
-import { accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, indexingNextActions, indexingStatuses, lifecycleErrorCodes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses } from "../onboarding.mjs";
 import { addPartnerTeamMemberSchema, bindPartnerSiteTeamSchema, bindPartnerTeamCatalogResponseSchema, bindPartnerTeamCatalogSchema, builderStateSchema, createPartnerTeamSchema, gscComparisonFilterSchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpPageTrendResponseSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapMembershipParamsSchema, gscdumpSitemapMembershipResponseSchema, gscdumpSitemapsResponseSchema, gscdumpTeamRoleSchema, gscdumpTopAssociationResponseSchema, gscdumpUserRegistrationSchema, indexingUrlsResponseSchema, partnerSiteTeamBindingResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, partnerTeamCreatedResponseSchema, partnerTeamDeletedResponseSchema, partnerTeamMemberAddedResponseSchema, partnerTeamMemberRemovedResponseSchema, partnerTeamMemberRoleResponseSchema, partnerTeamMembersResponseSchema, partnerTeamRenamedResponseSchema, registerPartnerSiteSchema, registerPartnerUserSchema, renamePartnerTeamSchema, searchTypeSchema, siteIntIdCrosswalkResponseSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema } from "../schemas.mjs";
-import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http.mjs";
+import "./version.mjs";
+import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.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 { z } from "zod";
-const GSCDUMP_HTTP_V1_VERSION = "1.0";
 function errorEnvelopeSchemas(codes, publicRequestId) {
 	const errorDetails = z.record(z.string(), z.json());
 	const producer = z.strictObject({
@@ -22,106 +22,9 @@ function errorEnvelopeSchemas(codes, publicRequestId) {
 	});
 	return defineResponseObject({ error: producer }, { error: client });
 }
-function lifecycleResponseSchemas(ids) {
-	const progress = defineResponseObject({
-		completed: z.number().int().nonnegative(),
-		failed: z.number().int().nonnegative(),
-		total: z.number().int().nonnegative(),
-		percent: z.number().min(0).max(100)
-	});
-	const latestError = defineResponseObject({
-		code: z.enum(lifecycleErrorCodes),
-		message: z.string(),
-		retryable: z.boolean()
-	});
-	const account = defineResponseObject({
-		status: z.enum(accountStatuses),
-		grantedScopes: z.array(z.string()),
-		missingScopes: z.array(z.string()),
-		nextAction: z.enum(accountNextActions)
-	});
-	const property = defineResponseObject({
-		status: z.enum(propertyStatuses),
-		nextAction: z.enum(propertyNextActions)
-	});
-	const syncedRange = defineResponseObject({
-		oldest: z.iso.date().nullable(),
-		newest: z.iso.date().nullable()
-	});
-	const analytics = defineResponseObject({
-		status: z.enum(analyticsStatuses),
-		progress: progress.producer,
-		queryable: z.boolean(),
-		sourceMode: z.enum(querySourceModes),
-		syncedRange: syncedRange.producer,
-		nextAction: z.enum(analyticsNextActions)
-	}, {
-		status: z.enum(analyticsStatuses),
-		progress: progress.client,
-		queryable: z.boolean(),
-		sourceMode: z.enum(querySourceModes),
-		syncedRange: syncedRange.client,
-		nextAction: z.enum(analyticsNextActions)
-	});
-	const sitemaps = defineResponseObject({
-		status: z.enum(sitemapStatuses),
-		discoveredCount: z.number().int().nonnegative(),
-		nextAction: z.enum(sitemapNextActions)
-	});
-	const indexing = defineResponseObject({
-		status: z.enum(indexingStatuses),
-		eligible: z.boolean(),
-		reason: z.string().nullable(),
-		progress: progress.producer,
-		nextAction: z.enum(indexingNextActions)
-	}, {
-		status: z.enum(indexingStatuses),
-		eligible: z.boolean(),
-		reason: z.string().nullable(),
-		progress: progress.client,
-		nextAction: z.enum(indexingNextActions)
-	});
-	const site = defineResponseObject({
-		siteId: ids.publicSiteId,
-		externalSiteId: z.string().nullable(),
-		requestedUrl: z.string().min(1),
-		gscPropertyUrl: z.string().nullable(),
-		permissionLevel: z.string().nullable(),
-		property: property.producer,
-		analytics: analytics.producer,
-		sitemaps: sitemaps.producer,
-		indexing: indexing.producer,
-		latestError: latestError.producer.nullable(),
-		updatedAt: z.iso.datetime()
-	}, {
-		siteId: ids.publicSiteId,
-		externalSiteId: z.string().nullable(),
-		requestedUrl: z.string().min(1),
-		gscPropertyUrl: z.string().nullable(),
-		permissionLevel: z.string().nullable(),
-		property: property.client,
-		analytics: analytics.client,
-		sitemaps: sitemaps.client,
-		indexing: indexing.client,
-		latestError: latestError.client.nullable(),
-		updatedAt: z.iso.datetime()
-	});
-	return defineResponseObject({
-		userId: ids.publicUserId,
-		partnerId: ids.publicPartnerId.nullable(),
-		currentTeamId: ids.publicTeamId.nullable(),
-		account: account.producer,
-		sites: z.array(site.producer)
-	}, {
-		userId: ids.publicUserId,
-		partnerId: ids.publicPartnerId.nullable(),
-		currentTeamId: ids.publicTeamId.nullable(),
-		account: account.client,
-		sites: z.array(site.client)
-	});
-}
 function createGscdumpV1Protocol() {
 	const realtimeSchemas = createRealtimeV1Schemas();
+	const browserSchemas = createGscdumpV1BrowserSchemas(realtimeSchemas);
 	const surfaceSchema = z.enum([
 		"partner",
 		"analytics",
@@ -149,100 +52,8 @@ function createGscdumpV1Protocol() {
 	});
 	const requestHeaders = z.strictObject({ "x-request-id": realtimeSchemas.publicRequestId.optional() });
 	const errorEnvelope = errorEnvelopeSchemas(HTTP_V1_ERROR_CODES, realtimeSchemas.publicRequestId);
-	const lifecycleResponse = defineSuccessResponse(lifecycleResponseSchemas(realtimeSchemas), partnerResponseMeta);
-	const dimensions = [
-		"page",
-		"query",
-		"queryCanonical",
-		"country",
-		"device",
-		"date",
-		"searchAppearance",
-		"hour"
-	];
-	const metrics = [
-		"clicks",
-		"impressions",
-		"ctr",
-		"position"
-	];
-	const filterDimension = z.enum([
-		...dimensions,
-		...metrics,
-		"searchType"
-	]);
-	const normalizedFilterLeaf = z.union([z.strictObject({
-		dimension: filterDimension,
-		operator: z.enum([
-			"equals",
-			"notEquals",
-			"contains",
-			"notContains",
-			"includingRegex",
-			"excludingRegex",
-			"gte",
-			"gt",
-			"lte",
-			"lt",
-			"metricGte",
-			"metricGt",
-			"metricLte",
-			"metricLt",
-			"topLevel"
-		]),
-		expression: z.string()
-	}), z.strictObject({
-		dimension: filterDimension,
-		operator: z.enum(["between", "metricBetween"]),
-		expression: z.string(),
-		expression2: z.string()
-	})]);
-	const normalizedFilter = z.lazy(() => z.union([z.strictObject({
-		_filters: z.array(normalizedFilterLeaf).min(1),
-		_nestedGroups: z.array(normalizedFilter).optional(),
-		_groupType: z.enum(["and", "or"]).optional()
-	}), z.strictObject({
-		_filters: z.array(normalizedFilterLeaf).max(0),
-		_nestedGroups: z.array(normalizedFilter).min(1),
-		_groupType: z.enum(["and", "or"]).optional()
-	})]));
-	const analyticsRowsRequest = z.strictObject({
-		dimensions: z.array(z.enum(dimensions)).min(1),
-		metrics: z.array(z.enum(metrics)).optional(),
-		filter: normalizedFilter.optional(),
-		prefilter: normalizedFilter.optional(),
-		orderBy: z.strictObject({
-			column: z.enum([...metrics, "date"]),
-			dir: z.enum(["asc", "desc"])
-		}).optional(),
-		rowLimit: z.number().int().positive().max(25e3).optional(),
-		startRow: z.number().int().nonnegative().optional(),
-		dataState: z.enum([
-			"final",
-			"all",
-			"hourly_all"
-		]).optional(),
-		aggregationType: z.enum([
-			"auto",
-			"byPage",
-			"byProperty",
-			"byNewsShowcasePanel"
-		]).optional(),
-		searchType: z.enum([
-			"web",
-			"image",
-			"video",
-			"news",
-			"discover",
-			"googleNews"
-		]).optional()
-	});
-	const analyticsRowData = defineResponseObject({ rows: z.array(z.record(z.string(), z.union([
-		z.string(),
-		z.number(),
-		z.boolean(),
-		z.null()
-	]))) });
+	const { analyticsRowsRequest, analyticsRowsResponse, lifecycleResponse } = browserSchemas;
+	const dimensions = GSCDUMP_V1_ANALYTICS_DIMENSIONS;
 	const analyticsMeta = defineResponseObject({
 		requestId: realtimeSchemas.publicRequestId,
 		surface: z.literal("analytics"),
@@ -251,7 +62,6 @@ function createGscdumpV1Protocol() {
 		sourceKind: z.enum(["row", "sql"]),
 		queryMs: z.number().nonnegative()
 	});
-	const analyticsRowsResponse = defineSuccessResponse(analyticsRowData, analyticsMeta);
 	const analyticsReportState = builderStateSchema.extend({ dimensions: z.array(z.enum(dimensions)).min(1) });
 	const analyticsListReportState = analyticsReportState.refine((state) => !state.dimensions.includes("date"), {
 		message: "List reports do not accept the date dimension.",
@@ -688,10 +498,13 @@ function createGscdumpV1Protocol() {
 		head: responseStreamHead.producer,
 		maxConnectionSeconds: z.literal(900)
 	};
-	const ticketResponse = defineSuccessResponse(defineResponseObject(ticketDataProducerShape, {
-		...ticketDataProducerShape,
-		head: responseStreamHead.client
-	}), realtimeResponseMeta);
+	const ticketResponse = {
+		producer: z.strictObject({
+			data: z.strictObject(ticketDataProducerShape),
+			meta: realtimeResponseMeta.producer
+		}),
+		client: realtimeSchemas.ticketResponseClient
+	};
 	const partnerUserLifecycleErrors = [
 		"invalid_request",
 		"unauthorized",
@@ -4279,4 +4092,4 @@ function createGscdumpV1Protocol() {
 		}
 	};
 }
-export { GSCDUMP_HTTP_V1_VERSION, createGscdumpV1Protocol };
+export { createGscdumpV1Protocol };

package/dist/v1/realtime.d.mts

@@ -121,6 +121,25 @@ declare function createRealtimeV1Schemas(): {
     streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
     sequence: z.ZodString;
   }, z.core.$strict>;
+  ticketResponseClient: z.ZodObject<{
+    data: z.ZodObject<{
+      socketUrl: z.ZodURL;
+      protocol: z.ZodLiteral<"gscdump.v1">;
+      protocolVersion: z.ZodLiteral<1>;
+      ticket: z.ZodString;
+      expiresAt: z.ZodISODateTime;
+      head: z.ZodObject<{
+        streamId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+        sequence: z.ZodString;
+      }, z.core.$loose>;
+      maxConnectionSeconds: z.ZodLiteral<900>;
+    }, z.core.$loose>;
+    meta: z.ZodObject<{
+      requestId: z.ZodString;
+      surface: z.ZodLiteral<"realtime">;
+      version: z.ZodLiteral<"1.0">;
+    }, z.core.$loose>;
+  }, z.core.$loose>;
   ticketRequest: z.ZodObject<{
     origin: z.ZodOptional<z.ZodURL>;
   }, z.core.$strict>;
@@ -641,10 +660,11 @@ type RealtimeV1Schemas = ReturnType<typeof createRealtimeV1Schemas>;
 type RealtimeV1StreamId = z.infer<RealtimeV1Schemas['streamId']>;
 type RealtimeV1Cursor = z.infer<RealtimeV1Schemas['cursor']>;
 type RealtimeV1StreamHead = z.infer<RealtimeV1Schemas['streamHead']>;
+type RealtimeTicketV1Response = z.infer<RealtimeV1Schemas['ticketResponseClient']>;
 type RealtimeV1TicketRequest = z.infer<RealtimeV1Schemas['ticketRequest']>;
 type RealtimeV1TicketClaims = z.infer<RealtimeV1Schemas['ticketClaims']>;
 type RealtimeV1ResourceChange = z.infer<RealtimeV1Schemas['resourceChange']>;
 type RealtimeV1Event = z.infer<RealtimeV1Schemas['event']>;
 type RealtimeV1ClientFrame = z.infer<RealtimeV1Schemas['clientFrame']>;
 type RealtimeV1ServerFrame = z.infer<RealtimeV1Schemas['serverFrame']>;
-export { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, createRealtimeV1Schemas };
+export { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, createRealtimeV1Schemas };

package/dist/v1/realtime.mjs

@@ -1,3 +1,4 @@
+import "./version.mjs";
 import { z } from "zod";
 const GSCDUMP_REALTIME_PROTOCOL_VERSION = 1;
 const GSCDUMP_REALTIME_SUBPROTOCOL = "gscdump.v1";
@@ -150,6 +151,25 @@ function createRealtimeV1Schemas() {
 		streamId,
 		sequence
 	});
+	const ticketResponseClient = z.looseObject({
+		data: z.looseObject({
+			socketUrl: z.url().refine((value) => value.startsWith("wss://"), "socketUrl must use wss."),
+			protocol: z.literal(GSCDUMP_REALTIME_SUBPROTOCOL),
+			protocolVersion: z.literal(1),
+			ticket: z.string().max(GSCDUMP_REALTIME_TICKET_POLICY.maxBytes).regex(/^gscdump\.ticket\.v1\.[\w-]+\.[\w-]+$/),
+			expiresAt: z.iso.datetime(),
+			head: z.looseObject({
+				streamId,
+				sequence
+			}),
+			maxConnectionSeconds: z.literal(900)
+		}),
+		meta: z.looseObject({
+			requestId: publicRequestId,
+			surface: z.literal("realtime"),
+			version: z.literal("1.0")
+		})
+	});
 	const ticketRequest = z.strictObject({ origin: origin.optional() });
 	const ticketClaims = z.strictObject({
 		v: z.literal(1),
@@ -416,6 +436,7 @@ function createRealtimeV1Schemas() {
 		streamId,
 		cursor,
 		streamHead,
+		ticketResponseClient,
 		ticketRequest,
 		ticketClaims,
 		knownResourceType,

package/dist/v1/server.d.mts

@@ -0,0 +1,6 @@
+import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
+import { CompatibleResponseSchema, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OwnershipRule, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, buildHttpOperationPath, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.mjs";
+import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, createRealtimeV1Schemas } from "./realtime.mjs";
+import { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, GscdumpV1ErrorEnvelope, GscdumpV1Protocol, GscdumpV1RequestMetadata, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, createGscdumpV1Protocol } from "./operations.mjs";
+import "./http.mjs";
+export { AnalyticsReportDetailV1Request, AnalyticsReportDetailV1Response, AnalyticsReportV1Request, AnalyticsReportV1Response, AnalyticsRowsV1Request, AnalyticsRowsV1Response, CompatibleResponseSchema, GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, GscdumpV1ErrorEnvelope, GscdumpV1Protocol, GscdumpV1RequestMetadata, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, HttpV1Credential, HttpV1ErrorCode, HttpV1Method, HttpV1OperationDefinition, HttpV1OwnershipRule, HttpV1RequestSchemas, HttpV1ResourceReference, HttpV1ResourceType, HttpV1Scope, HttpV1Semantics, HttpV1Surface, HttpV1SurfaceName, HttpV1Visibility, PartnerAnalysisBundleV1Response, PartnerAnalysisV1Response, PartnerAvailableSitesV1Response, PartnerIndexingDiagnosticsV1Response, PartnerIndexingUrlsV1Response, PartnerIndexingV1Response, PartnerSiteDeletionV1Response, PartnerSiteRegistrationV1Response, PartnerSitemapChangesV1Response, PartnerSitemapsV1Response, PartnerUserLifecycleV1Response, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, RealtimeTicketV1Response, RealtimeV1ClientFrame, RealtimeV1Cursor, RealtimeV1Event, RealtimeV1ResourceChange, RealtimeV1Schemas, RealtimeV1ServerFrame, RealtimeV1StreamHead, RealtimeV1StreamId, RealtimeV1TicketClaims, RealtimeV1TicketRequest, buildHttpOperationPath, createGscdumpV1Protocol, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse };

package/dist/v1/server.mjs

@@ -0,0 +1,6 @@
+import { GSCDUMP_HTTP_V1_VERSION } from "./version.mjs";
+import { HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, buildHttpOperationPath, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.mjs";
+import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, createRealtimeV1Schemas } from "./realtime.mjs";
+import { createGscdumpV1Protocol } from "./operations.mjs";
+import "./http.mjs";
+export { GSCDUMP_HTTP_V1_VERSION, GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_MAX_CONNECTION_SECONDS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_PROTOCOL_VERSION, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, GSCDUMP_REALTIME_TICKET_TTL_SECONDS, HTTP_V1_CREDENTIALS, HTTP_V1_CREDENTIAL_SCOPES, HTTP_V1_ERROR_CODES, HTTP_V1_METHODS, HTTP_V1_SCOPES, HTTP_V1_SURFACES, REALTIME_V1_EVENT_NAMES, REALTIME_V1_EVENT_SEMANTICS, REALTIME_V1_RESOURCE_TYPES, buildHttpOperationPath, createGscdumpV1Protocol, createRealtimeV1Schemas, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse };

package/dist/v1/version.d.mts

@@ -0,0 +1,2 @@
+declare const GSCDUMP_HTTP_V1_VERSION: '1.0';
+export { GSCDUMP_HTTP_V1_VERSION };

package/dist/v1/version.mjs

@@ -0,0 +1,2 @@
+const GSCDUMP_HTTP_V1_VERSION = "1.0";
+export { GSCDUMP_HTTP_V1_VERSION };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/contracts",
   "type": "module",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
   "author": {
     "name": "Harlan Wilton",
@@ -45,6 +45,31 @@
       "types": "./dist/v1/index.d.mts",
       "import": "./dist/v1/index.mjs",
       "default": "./dist/v1/index.mjs"
+    },
+    "./v1/browser": {
+      "types": "./dist/v1/browser.d.mts",
+      "import": "./dist/v1/browser.mjs",
+      "default": "./dist/v1/browser.mjs"
+    },
+    "./v1/documents": {
+      "types": "./dist/v1/documents.d.mts",
+      "import": "./dist/v1/documents.mjs",
+      "default": "./dist/v1/documents.mjs"
+    },
+    "./v1/http": {
+      "types": "./dist/v1/http.d.mts",
+      "import": "./dist/v1/http.mjs",
+      "default": "./dist/v1/http.mjs"
+    },
+    "./v1/realtime": {
+      "types": "./dist/v1/realtime.d.mts",
+      "import": "./dist/v1/realtime.mjs",
+      "default": "./dist/v1/realtime.mjs"
+    },
+    "./v1/server": {
+      "types": "./dist/v1/server.d.mts",
+      "import": "./dist/v1/server.mjs",
+      "default": "./dist/v1/server.mjs"
     }
   },
   "main": "./dist/index.mjs",