@gscdump/contracts 1.4.1 → 1.4.3

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 };