@gscdump/contracts 0.19.7 → 0.20.1

package/dist/index.d.mts

@@ -190,7 +190,6 @@ declare const analyticsRoutes: {
     readonly searchAppearance: (siteId: string) => string;
   };
 };
-declare const builderStateSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 /**
  * GSC search-type slice validator. Mirrors the `GscSearchType` union from
  * `gscdump/contracts` and the `SearchTypes` constants in `gscdump/query`. Used by consumers
@@ -205,6 +204,16 @@ declare const searchTypeSchema: z.ZodEnum<{
   discover: "discover";
   googleNews: "googleNews";
 }>;
+declare const builderStateSchema: z.ZodObject<{
+  searchType: z.ZodOptional<z.ZodEnum<{
+    web: "web";
+    image: "image";
+    video: "video";
+    news: "news";
+    discover: "discover";
+    googleNews: "googleNews";
+  }>>;
+}, z.core.$loose>;
 declare const gscComparisonFilterSchema: z.ZodEnum<{
   new: "new";
   lost: "lost";
@@ -1289,16 +1298,50 @@ declare const bulkRegisterPartnerSitesResponseSchema: z.ZodObject<{
   }, z.core.$strip>;
 }, z.core.$loose>;
 declare const dataQueryOptionsSchema: z.ZodOptional<z.ZodObject<{
-  comparison: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+  comparison: z.ZodOptional<z.ZodObject<{
+    searchType: z.ZodOptional<z.ZodEnum<{
+      web: "web";
+      image: "image";
+      video: "video";
+      news: "news";
+      discover: "discover";
+      googleNews: "googleNews";
+    }>>;
+  }, z.core.$loose>>;
   filter: z.ZodOptional<z.ZodEnum<{
     new: "new";
     lost: "lost";
     improving: "improving";
     declining: "declining";
   }>>;
+  searchType: z.ZodOptional<z.ZodEnum<{
+    web: "web";
+    image: "image";
+    video: "video";
+    news: "news";
+    discover: "discover";
+    googleNews: "googleNews";
+  }>>;
 }, z.core.$strip>>;
 declare const dataDetailOptionsSchema: z.ZodOptional<z.ZodObject<{
-  comparison: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+  comparison: z.ZodOptional<z.ZodObject<{
+    searchType: z.ZodOptional<z.ZodEnum<{
+      web: "web";
+      image: "image";
+      video: "video";
+      news: "news";
+      discover: "discover";
+      googleNews: "googleNews";
+    }>>;
+  }, z.core.$loose>>;
+  searchType: z.ZodOptional<z.ZodEnum<{
+    web: "web";
+    image: "image";
+    video: "video";
+    news: "news";
+    discover: "discover";
+    googleNews: "googleNews";
+  }>>;
 }, z.core.$strip>>;
 declare const gscdumpAnalysisPresetSchema: z.ZodEnum<{
   "striking-distance": "striking-distance";
@@ -2901,15 +2944,41 @@ declare const partnerEndpointSchemas: {
     }, z.core.$loose>;
   };
   readonly getData: {
-    readonly state: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    readonly state: z.ZodObject<{
+      searchType: z.ZodOptional<z.ZodEnum<{
+        web: "web";
+        image: "image";
+        video: "video";
+        news: "news";
+        discover: "discover";
+        googleNews: "googleNews";
+      }>>;
+    }, z.core.$loose>;
     readonly options: z.ZodOptional<z.ZodObject<{
-      comparison: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+      comparison: z.ZodOptional<z.ZodObject<{
+        searchType: z.ZodOptional<z.ZodEnum<{
+          web: "web";
+          image: "image";
+          video: "video";
+          news: "news";
+          discover: "discover";
+          googleNews: "googleNews";
+        }>>;
+      }, z.core.$loose>>;
       filter: z.ZodOptional<z.ZodEnum<{
         new: "new";
         lost: "lost";
         improving: "improving";
         declining: "declining";
       }>>;
+      searchType: z.ZodOptional<z.ZodEnum<{
+        web: "web";
+        image: "image";
+        video: "video";
+        news: "news";
+        discover: "discover";
+        googleNews: "googleNews";
+      }>>;
     }, z.core.$strip>>;
     readonly response: z.ZodObject<{
       rows: z.ZodArray<z.ZodObject<{
@@ -2945,9 +3014,35 @@ declare const partnerEndpointSchemas: {
     }, z.core.$strip>;
   };
   readonly getDataDetail: {
-    readonly state: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    readonly state: z.ZodObject<{
+      searchType: z.ZodOptional<z.ZodEnum<{
+        web: "web";
+        image: "image";
+        video: "video";
+        news: "news";
+        discover: "discover";
+        googleNews: "googleNews";
+      }>>;
+    }, z.core.$loose>;
     readonly options: z.ZodOptional<z.ZodObject<{
-      comparison: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+      comparison: z.ZodOptional<z.ZodObject<{
+        searchType: z.ZodOptional<z.ZodEnum<{
+          web: "web";
+          image: "image";
+          video: "video";
+          news: "news";
+          discover: "discover";
+          googleNews: "googleNews";
+        }>>;
+      }, z.core.$loose>>;
+      searchType: z.ZodOptional<z.ZodEnum<{
+        web: "web";
+        image: "image";
+        video: "video";
+        news: "news";
+        discover: "discover";
+        googleNews: "googleNews";
+      }>>;
     }, z.core.$strip>>;
     readonly response: z.ZodObject<{
       daily: z.ZodArray<z.ZodObject<{
@@ -3579,6 +3674,7 @@ interface TenantCtx {
 }
 type Dimension = 'page' | 'query' | 'queryCanonical' | 'country' | 'device' | 'date' | 'searchAppearance' | 'hour';
 type Metric = 'clicks' | 'impressions' | 'ctr' | 'position';
+type GscSearchType = 'web' | 'image' | 'video' | 'news' | 'discover' | 'googleNews';
 type Filter = unknown;
 interface BuilderState {
   dimensions: Dimension[];
@@ -3590,6 +3686,7 @@ interface BuilderState {
   };
   rowLimit?: number;
   startRow?: number;
+  searchType?: GscSearchType;
 }
 interface GscApiRange {
   start: string;
@@ -3884,8 +3981,8 @@ interface BackfillResponse {
 interface AnalyticsClient {
   whoami: () => Promise<WhoamiResponse>;
   listSites: () => Promise<SiteListItem[]>;
-  getSourceInfo: (siteId: string) => Promise<SourceInfoResponse>;
-  getAnalysisSources: (siteId: string, tables?: string[] | string) => Promise<AnalysisSourcesResponse>;
+  getSourceInfo: (siteId: string, options?: SourceInfoOptions) => Promise<SourceInfoResponse>;
+  getAnalysisSources: (siteId: string, tables?: string[] | string | AnalysisSourcesOptions, options?: SearchTypeOptions | SourceInfoOptions) => Promise<AnalysisSourcesResponse>;
   analyze: <T = unknown>(siteId: string, params: unknown) => Promise<T>;
   queryRows: <T = Record<string, unknown>>(siteId: string, state: unknown) => Promise<GscRowQueryResponse<T>>;
   getRollup: <T = unknown>(siteId: string, rollupId: string, params?: {
@@ -4304,6 +4401,7 @@ interface GscdumpAnalysisParams {
   minPosition?: number;
   maxPosition?: number;
   maxCtr?: number;
+  searchType?: GscSearchType;
 }
 interface GscdumpAnalysisResponse {
   preset: GscdumpAnalysisPreset;
@@ -4379,13 +4477,38 @@ interface GscdumpAnalysisSourcesResponse {
   tables: Record<string, string[]>;
   generatedAt: string;
   manifestVersion: string;
+  searchType?: GscSearchType;
+  canUseBrowser?: boolean;
+  fallback?: string;
+  reason?: string;
+  estimatedBytes?: number;
+  estimatedFiles?: number;
+  coveragePlan?: unknown;
+}
+interface SearchTypeOptions {
+  searchType?: GscSearchType;
+}
+interface SourceInfoOptions extends SearchTypeOptions {
+  start?: string;
+  end?: string;
+  startDate?: string;
+  endDate?: string;
+}
+interface AnalysisSourcesOptions extends SearchTypeOptions {
+  tables?: string[] | string;
+  start?: string;
+  end?: string;
+  startDate?: string;
+  endDate?: string;
 }
 interface DataQueryOptions {
   comparison?: BuilderState;
   filter?: GscComparisonFilter;
+  searchType?: GscSearchType;
 }
 interface DataDetailOptions {
   comparison?: BuilderState;
+  searchType?: GscSearchType;
 }
 interface IndexingUrlsParams {
   limit?: number;
@@ -4718,7 +4841,7 @@ interface PartnerClient {
   deleteSite: (siteId: string) => Promise<{
     success: boolean;
   }>;
-  getAnalysisSources: (siteId: string, tables?: string[] | string) => Promise<GscdumpAnalysisSourcesResponse>;
+  getAnalysisSources: (siteId: string, tables?: string[] | string | AnalysisSourcesOptions, options?: SearchTypeOptions | SourceInfoOptions) => Promise<GscdumpAnalysisSourcesResponse>;
   getSiteSyncStatus: (siteId: string, userId?: string) => Promise<GscdumpSyncStatusResponse>;
   getData: (siteId: string, state: BuilderState, options?: DataQueryOptions) => Promise<GscdumpDataResponse>;
   getDataDetail: (siteId: string, state: BuilderState, options?: DataDetailOptions) => Promise<GscdumpDataDetailResponse>;
@@ -4952,4 +5075,4 @@ declare const WEBHOOK_CONTRACT_VERSION_HEADER = "X-GSCDump-Contract-Version";
 declare const WEBHOOK_TIMESTAMP_HEADER = "X-GSCDump-Timestamp";
 declare const CANONICAL_WEBHOOK_EVENTS: readonly ["user.lifecycle.changed", "site.lifecycle.changed", "site.analytics.ready", "site.indexing.ready", "site.auth.failed", "job.failed"];
 declare const VALID_WEBHOOK_EVENTS: readonly ["user.lifecycle.changed", "site.lifecycle.changed", "site.analytics.ready", "site.indexing.ready", "site.auth.failed", "job.failed"];
-export { AccountNextAction, AccountStatus, type AddPartnerTeamMemberParams, type AnalysisSourcesResponse, type AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BuilderState, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, CANONICAL_WEBHOOK_EVENTS, type CanonicalWebhookEventType, type ColumnDef, type ColumnType, type CountriesResponse, type CountryRow, type CreatePartnerTeamParams, type CreateWebhookEnvelopeOptions, type DataDetailOptions, type DataQueryOptions, type DeletePartnerUserResponse, type Dimension, type Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, type Grain, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpDateRangeParams, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapHistory, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamMemberRow, type GscdumpTeamRow, type GscdumpTopAssociationParams, type GscdumpTopAssociationResponse, type GscdumpTotals, type GscdumpUserMeResponse, type GscdumpUserRegistration, type GscdumpUserSettings, type GscdumpUserSite, type GscdumpUserStatus, type GscdumpUserTokenUpdate, type IndexingDiagnostics, type IndexingInspectRateLimit, type IndexingInspectRateLimited, type IndexingInspectRequest, type IndexingInspectResponse, type IndexingInspectResult, type IndexingIssue, type IndexingIssueSeverity, IndexingNextAction, IndexingStatus, type IndexingUrlRow, type IndexingUrlStatus, type IndexingUrlsParams, type IndexingUrlsResponse, type InspectionHistoryRecord, type InspectionHistoryResponse, type InspectionIndex, type InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, type Metric, type PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, type PartnerRealtimeEvent, type PartnerRealtimeEventType, type PartnerRealtimeMessage, type PartnerWebhookData, type PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, type RealtimeAuthFailedEvent, type RealtimeAuthRequiredMessage, type RealtimeConnectedMessage, type RealtimeEnrichmentCompleteEvent, type RealtimeErrorMessage, type RealtimeJobFailedEvent, type RealtimeNeedsReauthEvent, type RealtimePongMessage, type RealtimeSiteAddedEvent, type RealtimeSiteRemovedEvent, type RealtimeSubscribedMessage, type RealtimeSyncCompleteEvent, type RealtimeSyncFailedEvent, type RealtimeSyncJobCompleteEvent, type RealtimeSyncProgressEvent, type RealtimeSyncSiteCompleteEvent, type RegisterPartnerSiteParams, type RegisterPartnerUserParams, type RollupEnvelope, type Row, type ScheduleState, type SearchAppearanceResponse, type SearchAppearanceRow, type SiteListItem, type SitemapAddedRow, type SitemapChangesResponse, type SitemapHistoryRecord, type SitemapHistoryResponse, type SitemapIndex, SitemapNextAction, type SitemapRemovedRow, SitemapStatus, type SourceInfoResponse, type TableName, type TableSchema, type TenantCtx, type UpdatePartnerUserTokensParams, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, type WebhookEnvelope, type WebhookEventType, type WhoamiResponse, accountNextActions, accountStatuses, addPartnerTeamMemberSchema, analyticsNextActions, analyticsRoutes, analyticsStatuses, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, builderStateSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDateRangeParamsSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingNextActions, indexingStatuses, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, parseGrantedScopes, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };
+export { AccountNextAction, AccountStatus, type AddPartnerTeamMemberParams, type AnalysisSourcesOptions, type AnalysisSourcesResponse, type AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BuilderState, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, CANONICAL_WEBHOOK_EVENTS, type CanonicalWebhookEventType, type ColumnDef, type ColumnType, type CountriesResponse, type CountryRow, type CreatePartnerTeamParams, type CreateWebhookEnvelopeOptions, type DataDetailOptions, type DataQueryOptions, type DeletePartnerUserResponse, type Dimension, type Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, type Grain, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscSearchType, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpDateRangeParams, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapHistory, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamMemberRow, type GscdumpTeamRow, type GscdumpTopAssociationParams, type GscdumpTopAssociationResponse, type GscdumpTotals, type GscdumpUserMeResponse, type GscdumpUserRegistration, type GscdumpUserSettings, type GscdumpUserSite, type GscdumpUserStatus, type GscdumpUserTokenUpdate, type IndexingDiagnostics, type IndexingInspectRateLimit, type IndexingInspectRateLimited, type IndexingInspectRequest, type IndexingInspectResponse, type IndexingInspectResult, type IndexingIssue, type IndexingIssueSeverity, IndexingNextAction, IndexingStatus, type IndexingUrlRow, type IndexingUrlStatus, type IndexingUrlsParams, type IndexingUrlsResponse, type InspectionHistoryRecord, type InspectionHistoryResponse, type InspectionIndex, type InspectionRecordRaw, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, type Metric, type PartnerClient, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, type PartnerRealtimeEvent, type PartnerRealtimeEventType, type PartnerRealtimeMessage, type PartnerWebhookData, type PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, type RealtimeAuthFailedEvent, type RealtimeAuthRequiredMessage, type RealtimeConnectedMessage, type RealtimeEnrichmentCompleteEvent, type RealtimeErrorMessage, type RealtimeJobFailedEvent, type RealtimeNeedsReauthEvent, type RealtimePongMessage, type RealtimeSiteAddedEvent, type RealtimeSiteRemovedEvent, type RealtimeSubscribedMessage, type RealtimeSyncCompleteEvent, type RealtimeSyncFailedEvent, type RealtimeSyncJobCompleteEvent, type RealtimeSyncProgressEvent, type RealtimeSyncSiteCompleteEvent, type RegisterPartnerSiteParams, type RegisterPartnerUserParams, type RollupEnvelope, type Row, type ScheduleState, type SearchAppearanceResponse, type SearchAppearanceRow, type SearchTypeOptions, type SiteListItem, type SitemapAddedRow, type SitemapChangesResponse, type SitemapHistoryRecord, type SitemapHistoryResponse, type SitemapIndex, SitemapNextAction, type SitemapRemovedRow, SitemapStatus, type SourceInfoOptions, type SourceInfoResponse, type TableName, type TableSchema, type TenantCtx, type UpdatePartnerUserTokensParams, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, type WebhookEnvelope, type WebhookEventType, type WhoamiResponse, accountNextActions, accountStatuses, addPartnerTeamMemberSchema, analyticsNextActions, analyticsRoutes, analyticsStatuses, backfillRangeSchema, backfillResponseSchema, bindPartnerSiteTeamSchema, builderStateSchema, bulkRegisterPartnerSitesResponseSchema, bulkRegisterPartnerSitesSchema, canonicalWebhookEventTypeSchema, countriesResponseSchema, countryRowSchema, createPartnerTeamSchema, dataDetailOptionsSchema, dataQueryOptionsSchema, gscApiRangeSchema, gscComparisonFilterSchema, gscRowQueryMetaSchema, gscRowQueryResponseSchema, gscdumpAnalysisParamsSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAnalysisSourcesResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDataRowSchema, gscdumpDateRangeParamsSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpHealthResponseSchema, gscdumpIndexPercentParamsSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingUrlsResponseSchema, gscdumpKeywordSparklinesParamsSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpMetaSchema, gscdumpPermissionRecoverySchema, gscdumpQueryTrendParamsSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSiteReportResponseSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapsResponseSchema, gscdumpSyncJobsResponseSchema, gscdumpSyncProgressResponseSchema, gscdumpTeamMemberRowSchema, gscdumpTeamRoleSchema, gscdumpTeamRowSchema, gscdumpTopAssociationParamsSchema, gscdumpTopAssociationResponseSchema, gscdumpTotalsSchema, gscdumpUserMeResponseSchema, gscdumpUserRegistrationSchema, gscdumpUserSettingsSchema, gscdumpUserSiteSchema, gscdumpUserStatusSchema, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingDiagnosticsSchema, indexingInspectAnyResponseSchema, indexingInspectRateLimitedSchema, indexingInspectRequestSchema, indexingInspectResponseSchema, indexingInspectResultSchema, indexingIssueSchema, indexingNextActions, indexingStatuses, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, inspectionRecordRawSchema, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, parseGrantedScopes, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, scheduleStateSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };

package/dist/index.mjs

@@ -219,7 +219,6 @@ const CANONICAL_WEBHOOK_EVENTS = [
 ];
 const VALID_WEBHOOK_EVENTS = CANONICAL_WEBHOOK_EVENTS;
 const unknownRecord = z.record(z.string(), z.unknown());
-const builderStateSchema = unknownRecord;
 const searchTypeSchema = z.enum([
 	"web",
 	"image",
@@ -228,6 +227,7 @@ const searchTypeSchema = z.enum([
 	"discover",
 	"googleNews"
 ]);
+const builderStateSchema = z.object({ searchType: searchTypeSchema.optional() }).loose();
 const gscComparisonFilterSchema = z.enum([
 	"new",
 	"lost",
@@ -730,9 +730,13 @@ const bulkRegisterPartnerSitesResponseSchema = z.object({
 }).loose();
 const dataQueryOptionsSchema = z.object({
 	comparison: builderStateSchema.optional(),
-	filter: gscComparisonFilterSchema.optional()
+	filter: gscComparisonFilterSchema.optional(),
+	searchType: searchTypeSchema.optional()
+}).optional();
+const dataDetailOptionsSchema = z.object({
+	comparison: builderStateSchema.optional(),
+	searchType: searchTypeSchema.optional()
 }).optional();
-const dataDetailOptionsSchema = z.object({ comparison: builderStateSchema.optional() }).optional();
 const gscdumpAnalysisPresetSchema = z.enum([
 	"striking-distance",
 	"opportunity",

package/package.json

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