@gscdump/contracts 5.3.0 → 5.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/partner.d.mts +2 -1
- package/dist/partner.mjs +2 -1
- package/dist/site-version.d.mts +380 -0
- package/dist/site-version.mjs +102 -0
- package/dist/v1/analytics-coverage.d.mts +56 -0
- package/dist/v1/analytics-coverage.mjs +25 -0
- package/dist/v1/bing-sites.mjs +1 -1
- package/dist/v1/http-core.d.mts +1 -1
- package/dist/v1/http-core.mjs +2 -0
- package/dist/v1/http.d.mts +2 -1
- package/dist/v1/http.mjs +3 -2
- package/dist/v1/index.d.mts +2 -1
- package/dist/v1/index.mjs +3 -2
- package/dist/v1/operations.d.mts +3172 -2
- package/dist/v1/operations.mjs +545 -1
- package/dist/v1/route-catalog.d.mts +40 -0
- package/dist/v1/route-catalog.mjs +40 -0
- package/package.json +1 -1
package/dist/partner.d.mts
CHANGED
|
@@ -4,4 +4,5 @@ import { partnerControlEndpointSchemas } from "./schemas.mjs";
|
|
|
4
4
|
import { AccountNextAction, AccountStatus, AnalyticsNextAction, AnalyticsStatus, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, IndexingNextAction, IndexingStatus, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, PropertyNextAction, PropertyStatus, QuerySourceMode, SitemapNextAction, SitemapStatus, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingNextActions, indexingStatuses, lifecycleErrorCodes, parseGrantedScopes, propertyNextActions, propertyStatuses, querySourceModes, sitemapNextActions, sitemapStatuses } from "./onboarding.mjs";
|
|
5
5
|
import { AddPartnerTeamMemberParams, AnalysisSourcesOptions, AnalysisSourcesResponse, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BindPartnerTeamCatalogParams, BindPartnerTeamCatalogResponse, BuilderStateWire, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CanonicalWebhookEnvelope, CanonicalWebhookEventData, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, Filter, Grain, GscAddAndVerifyResponse, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscVerificationDnsRecord, GscVerificationMethod, GscVerificationRequest, GscVerificationSite, GscVerificationTokenResponse, GscdumpAnalysisBundleParams, GscdumpAnalysisBundleResponse, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalDifferenceKind, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingIssueSeverity, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPageTrendParams, GscdumpPageTrendResponse, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpRichResultItem, GscdumpSiteIntIdCrosswalkEntry, GscdumpSiteIntIdCrosswalkResponse, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapExportResponse, GscdumpSitemapFeed, GscdumpSitemapGeneration, GscdumpSitemapHistory, GscdumpSitemapMembershipEvidence, GscdumpSitemapMembershipParams, GscdumpSitemapMembershipResponse, GscdumpSitemapUrlsResponse, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamCatalogRef, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingDiagnosticsParams, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, InspectionRecordRaw, Metric, PartnerSitemapAction, PartnerSitemapActionResponse, PartnerWebhookData, PartnerWebhookHeaders, RegisterPartnerSiteParams, RegisterPartnerUserParams, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SearchConsoleGrantOutcome, SearchTypeOptions, SiteListItem, SitemapAddedRow, SitemapChangesCompleteness, SitemapChangesResponse, SitemapRemovedRow, SourceInfoOptions, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, WebhookEnvelope, WebhookEventType, WhoamiResponse } from "./types.mjs";
|
|
6
6
|
import { CANONICAL_WEBHOOK_EVENTS, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER } from "./webhook-constants.mjs";
|
|
7
|
-
|
|
7
|
+
import { SiteVersionCandidate, SiteVersionIdentity, SiteVersionIdentityResponse, SiteVersionPreview, SiteVersionSlice, SiteVersionWindow, siteVersionBeginRequestSchema, siteVersionCandidateRequestSchema, siteVersionCandidateSchema, siteVersionIdentityResponseSchema, siteVersionIdentitySchema, siteVersionPreviewRequestSchema, siteVersionPreviewSchema, siteVersionRefusalSchema, siteVersionSliceSchema, siteVersionWindowSchema } from "./site-version.mjs";
|
|
8
|
+
export { AccountNextAction, AccountStatus, type AddPartnerTeamMemberParams, type AnalysisSourcesOptions, type AnalysisSourcesResponse, AnalyticsNextAction, AnalyticsStatus, type BackfillRange, type BackfillResponse, type BindPartnerSiteTeamParams, type BindPartnerTeamCatalogParams, type BindPartnerTeamCatalogResponse, type BuilderStateWire, type BulkRegisterPartnerSiteResult, type BulkRegisterPartnerSitesParams, type BulkRegisterPartnerSitesResponse, CANONICAL_WEBHOOK_EVENTS, type CanonicalWebhookEnvelope, type CanonicalWebhookEventData, 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, GSCDUMP_WRITE_ANALYTICS_SCOPE, type Grain, type GscAddAndVerifyResponse, type GscApiRange, type GscComparisonFilter, type GscRowQueryMeta, type GscRowQueryResponse, type GscVerificationDnsRecord, type GscVerificationMethod, type GscVerificationRequest, type GscVerificationSite, type GscVerificationTokenResponse, type GscdumpAnalysisBundleParams, type GscdumpAnalysisBundleResponse, type GscdumpAnalysisParams, type GscdumpAnalysisPreset, type GscdumpAnalysisResponse, type GscdumpAnalysisSourcesResponse, type GscdumpAvailableSite, type GscdumpCanonicalDifferenceKind, type GscdumpCanonicalMismatchRow, type GscdumpCanonicalMismatchesResponse, type GscdumpDataDetailResponse, type GscdumpDataResponse, type GscdumpDataRow, type GscdumpHealthResponse, type GscdumpIndexPercentResponse, type GscdumpIndexPercentSitemap, type GscdumpIndexPercentTrendPoint, type GscdumpIndexingDiagnosticsResponse, type GscdumpIndexingInspectRateLimited, type GscdumpIndexingInspectRequest, type GscdumpIndexingInspectResponse, type GscdumpIndexingInspectResult, type GscdumpIndexingIssueSeverity, type GscdumpIndexingResponse, type GscdumpIndexingTrendPoint, type GscdumpIndexingUrl, type GscdumpIndexingUrlStatus, type GscdumpIndexingUrlsResponse, type GscdumpInvisibleUrlRow, type GscdumpKeywordSparklinesParams, type GscdumpKeywordSparklinesResponse, type GscdumpMeta, type GscdumpOrphanPageRow, type GscdumpPageTrendParams, type GscdumpPageTrendResponse, type GscdumpPerSitemapHistoryEntry, type GscdumpPermissionRecovery, type GscdumpQueryTrendParams, type GscdumpQueryTrendResponse, type GscdumpRichResultItem, type GscdumpSiteIntIdCrosswalkEntry, type GscdumpSiteIntIdCrosswalkResponse, type GscdumpSiteRegistration, type GscdumpSiteReportResponse, type GscdumpSitemap, type GscdumpSitemapChangesResponse, type GscdumpSitemapExportResponse, type GscdumpSitemapFeed, type GscdumpSitemapGeneration, type GscdumpSitemapHistory, type GscdumpSitemapMembershipEvidence, type GscdumpSitemapMembershipParams, type GscdumpSitemapMembershipResponse, type GscdumpSitemapUrlsResponse, type GscdumpSitemapsResponse, type GscdumpSyncJobItem, type GscdumpSyncJobStatus, type GscdumpSyncJobsQueueCounts, type GscdumpSyncJobsResponse, type GscdumpSyncProgressDateStatus, type GscdumpSyncProgressPhaseCounts, type GscdumpSyncProgressResponse, type GscdumpSyncProgressSite, type GscdumpSyncStatusResponse, type GscdumpTeamCatalogRef, 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 IndexingDiagnosticsParams, 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, PartnerLifecycleAccount, PartnerLifecycleResponse, PartnerLifecycleSite, type PartnerSitemapAction, type PartnerSitemapActionResponse, type PartnerWebhookData, type PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, type RegisterPartnerSiteParams, type RegisterPartnerUserParams, type RollupEnvelope, type Row, type ScheduleState, type SearchAppearanceResponse, type SearchAppearanceRow, type SearchConsoleGrantOutcome, type SearchTypeOptions, type SiteListItem, SiteVersionCandidate, SiteVersionIdentity, SiteVersionIdentityResponse, SiteVersionPreview, SiteVersionSlice, SiteVersionWindow, type SitemapAddedRow, type SitemapChangesCompleteness, type SitemapChangesResponse, 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, analyticsNextActions, analyticsStatuses, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingNextActions, indexingStatuses, lifecycleErrorCodes, parseGrantedScopes, partnerControlEndpointSchemas, partnerControlEndpointSchemas as partnerEndpointSchemas, partnerEndpoints, partnerRoutes, propertyNextActions, propertyStatuses, querySourceModes, siteVersionBeginRequestSchema, siteVersionCandidateRequestSchema, siteVersionCandidateSchema, siteVersionIdentityResponseSchema, siteVersionIdentitySchema, siteVersionPreviewRequestSchema, siteVersionPreviewSchema, siteVersionRefusalSchema, siteVersionSliceSchema, siteVersionWindowSchema, sitemapNextActions, sitemapStatuses };
|
package/dist/partner.mjs
CHANGED
|
@@ -3,4 +3,5 @@ import { partnerRoutes } from "./routes.mjs";
|
|
|
3
3
|
import { CANONICAL_WEBHOOK_EVENTS, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER } from "./webhook-constants.mjs";
|
|
4
4
|
import { partnerControlEndpointSchemas } from "./schemas.mjs";
|
|
5
5
|
import { partnerEndpoints } from "./endpoints.mjs";
|
|
6
|
-
|
|
6
|
+
import { siteVersionBeginRequestSchema, siteVersionCandidateRequestSchema, siteVersionCandidateSchema, siteVersionIdentityResponseSchema, siteVersionIdentitySchema, siteVersionPreviewRequestSchema, siteVersionPreviewSchema, siteVersionRefusalSchema, siteVersionSliceSchema, siteVersionWindowSchema } from "./site-version.mjs";
|
|
7
|
+
export { CANONICAL_WEBHOOK_EVENTS, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GSCDUMP_WRITE_ANALYTICS_SCOPE, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, accountNextActions, accountStatuses, analyticsNextActions, analyticsStatuses, hasOptionalIndexingScope, hasRequiredAnalyticsScope, indexingNextActions, indexingStatuses, lifecycleErrorCodes, parseGrantedScopes, partnerControlEndpointSchemas, partnerControlEndpointSchemas as partnerEndpointSchemas, partnerEndpoints, partnerRoutes, propertyNextActions, propertyStatuses, querySourceModes, siteVersionBeginRequestSchema, siteVersionCandidateRequestSchema, siteVersionCandidateSchema, siteVersionIdentityResponseSchema, siteVersionIdentitySchema, siteVersionPreviewRequestSchema, siteVersionPreviewSchema, siteVersionRefusalSchema, siteVersionSliceSchema, siteVersionWindowSchema, sitemapNextActions, sitemapStatuses };
|
|
@@ -0,0 +1,380 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
export declare const siteVersionIdentitySchema: z.ZodObject<{
|
|
3
|
+
siteId: z.ZodString;
|
|
4
|
+
userId: z.ZodString;
|
|
5
|
+
teamId: z.ZodUnion<readonly [z.ZodUUID, z.ZodString]>;
|
|
6
|
+
requestedUrl: z.ZodURL;
|
|
7
|
+
catalogSiteId: z.ZodNumber;
|
|
8
|
+
warehouse: z.ZodString;
|
|
9
|
+
namespace: z.ZodString;
|
|
10
|
+
version: z.ZodNumber;
|
|
11
|
+
revision: z.ZodNumber;
|
|
12
|
+
catalogRevision: z.ZodNumber;
|
|
13
|
+
dataVersion: z.ZodNumber;
|
|
14
|
+
}, z.core.$strict>;
|
|
15
|
+
export declare const siteVersionWindowSchema: z.ZodObject<{
|
|
16
|
+
startDate: z.ZodISODate;
|
|
17
|
+
endDate: z.ZodISODate;
|
|
18
|
+
}, z.core.$strict>;
|
|
19
|
+
export declare const siteVersionSliceSchema: z.ZodObject<{
|
|
20
|
+
table: z.ZodEnum<{
|
|
21
|
+
pages: "pages";
|
|
22
|
+
queries: "queries";
|
|
23
|
+
countries: "countries";
|
|
24
|
+
page_queries: "page_queries";
|
|
25
|
+
dates: "dates";
|
|
26
|
+
search_appearance: "search_appearance";
|
|
27
|
+
search_appearance_pages: "search_appearance_pages";
|
|
28
|
+
search_appearance_queries: "search_appearance_queries";
|
|
29
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
30
|
+
hourly_pages: "hourly_pages";
|
|
31
|
+
}>;
|
|
32
|
+
searchType: z.ZodEnum<{
|
|
33
|
+
readonly WEB: "web";
|
|
34
|
+
readonly IMAGE: "image";
|
|
35
|
+
readonly VIDEO: "video";
|
|
36
|
+
readonly NEWS: "news";
|
|
37
|
+
readonly DISCOVER: "discover";
|
|
38
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
39
|
+
}>;
|
|
40
|
+
}, z.core.$strict>;
|
|
41
|
+
export declare const siteVersionPreviewRequestSchema: z.ZodObject<{
|
|
42
|
+
requestedUrl: z.ZodURL;
|
|
43
|
+
catalogSiteId: z.ZodNumber;
|
|
44
|
+
window: z.ZodObject<{
|
|
45
|
+
startDate: z.ZodISODate;
|
|
46
|
+
endDate: z.ZodISODate;
|
|
47
|
+
}, z.core.$strict>;
|
|
48
|
+
}, z.core.$strict>;
|
|
49
|
+
export declare const siteVersionRefusalSchema: z.ZodEnum<{
|
|
50
|
+
"catalog-identity-mismatch": "catalog-identity-mismatch";
|
|
51
|
+
"identity-changed": "identity-changed";
|
|
52
|
+
"host-reserved": "host-reserved";
|
|
53
|
+
"not-eligible": "not-eligible";
|
|
54
|
+
"property-unavailable": "property-unavailable";
|
|
55
|
+
"catalog-unavailable": "catalog-unavailable";
|
|
56
|
+
"provisioning-incomplete": "provisioning-incomplete";
|
|
57
|
+
"coverage-incomplete": "coverage-incomplete";
|
|
58
|
+
"candidate-aborted": "candidate-aborted";
|
|
59
|
+
"candidate-failed": "candidate-failed";
|
|
60
|
+
}>;
|
|
61
|
+
export declare const siteVersionPreviewSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
62
|
+
_tag: z.ZodLiteral<"eligible">;
|
|
63
|
+
identity: z.ZodObject<{
|
|
64
|
+
siteId: z.ZodString;
|
|
65
|
+
userId: z.ZodString;
|
|
66
|
+
teamId: z.ZodUnion<readonly [z.ZodUUID, z.ZodString]>;
|
|
67
|
+
requestedUrl: z.ZodURL;
|
|
68
|
+
catalogSiteId: z.ZodNumber;
|
|
69
|
+
warehouse: z.ZodString;
|
|
70
|
+
namespace: z.ZodString;
|
|
71
|
+
version: z.ZodNumber;
|
|
72
|
+
revision: z.ZodNumber;
|
|
73
|
+
catalogRevision: z.ZodNumber;
|
|
74
|
+
dataVersion: z.ZodNumber;
|
|
75
|
+
}, z.core.$strict>;
|
|
76
|
+
requestedUrl: z.ZodURL;
|
|
77
|
+
window: z.ZodObject<{
|
|
78
|
+
startDate: z.ZodISODate;
|
|
79
|
+
endDate: z.ZodISODate;
|
|
80
|
+
}, z.core.$strict>;
|
|
81
|
+
requiredSlices: z.ZodArray<z.ZodObject<{
|
|
82
|
+
table: z.ZodEnum<{
|
|
83
|
+
pages: "pages";
|
|
84
|
+
queries: "queries";
|
|
85
|
+
countries: "countries";
|
|
86
|
+
page_queries: "page_queries";
|
|
87
|
+
dates: "dates";
|
|
88
|
+
search_appearance: "search_appearance";
|
|
89
|
+
search_appearance_pages: "search_appearance_pages";
|
|
90
|
+
search_appearance_queries: "search_appearance_queries";
|
|
91
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
92
|
+
hourly_pages: "hourly_pages";
|
|
93
|
+
}>;
|
|
94
|
+
searchType: z.ZodEnum<{
|
|
95
|
+
readonly WEB: "web";
|
|
96
|
+
readonly IMAGE: "image";
|
|
97
|
+
readonly VIDEO: "video";
|
|
98
|
+
readonly NEWS: "news";
|
|
99
|
+
readonly DISCOVER: "discover";
|
|
100
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
101
|
+
}>;
|
|
102
|
+
}, z.core.$strict>>;
|
|
103
|
+
candidateNamespace: z.ZodString;
|
|
104
|
+
candidateVersion: z.ZodNumber;
|
|
105
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
106
|
+
_tag: z.ZodLiteral<"blocked">;
|
|
107
|
+
reason: z.ZodEnum<{
|
|
108
|
+
"catalog-identity-mismatch": "catalog-identity-mismatch";
|
|
109
|
+
"identity-changed": "identity-changed";
|
|
110
|
+
"host-reserved": "host-reserved";
|
|
111
|
+
"not-eligible": "not-eligible";
|
|
112
|
+
"property-unavailable": "property-unavailable";
|
|
113
|
+
"catalog-unavailable": "catalog-unavailable";
|
|
114
|
+
"provisioning-incomplete": "provisioning-incomplete";
|
|
115
|
+
"coverage-incomplete": "coverage-incomplete";
|
|
116
|
+
"candidate-aborted": "candidate-aborted";
|
|
117
|
+
"candidate-failed": "candidate-failed";
|
|
118
|
+
}>;
|
|
119
|
+
}, z.core.$strict>], "_tag">;
|
|
120
|
+
export declare const siteVersionBeginRequestSchema: z.ZodObject<{
|
|
121
|
+
preview: z.ZodObject<{
|
|
122
|
+
_tag: z.ZodLiteral<"eligible">;
|
|
123
|
+
identity: z.ZodObject<{
|
|
124
|
+
siteId: z.ZodString;
|
|
125
|
+
userId: z.ZodString;
|
|
126
|
+
teamId: z.ZodUnion<readonly [z.ZodUUID, z.ZodString]>;
|
|
127
|
+
requestedUrl: z.ZodURL;
|
|
128
|
+
catalogSiteId: z.ZodNumber;
|
|
129
|
+
warehouse: z.ZodString;
|
|
130
|
+
namespace: z.ZodString;
|
|
131
|
+
version: z.ZodNumber;
|
|
132
|
+
revision: z.ZodNumber;
|
|
133
|
+
catalogRevision: z.ZodNumber;
|
|
134
|
+
dataVersion: z.ZodNumber;
|
|
135
|
+
}, z.core.$strict>;
|
|
136
|
+
requestedUrl: z.ZodURL;
|
|
137
|
+
window: z.ZodObject<{
|
|
138
|
+
startDate: z.ZodISODate;
|
|
139
|
+
endDate: z.ZodISODate;
|
|
140
|
+
}, z.core.$strict>;
|
|
141
|
+
requiredSlices: z.ZodArray<z.ZodObject<{
|
|
142
|
+
table: z.ZodEnum<{
|
|
143
|
+
pages: "pages";
|
|
144
|
+
queries: "queries";
|
|
145
|
+
countries: "countries";
|
|
146
|
+
page_queries: "page_queries";
|
|
147
|
+
dates: "dates";
|
|
148
|
+
search_appearance: "search_appearance";
|
|
149
|
+
search_appearance_pages: "search_appearance_pages";
|
|
150
|
+
search_appearance_queries: "search_appearance_queries";
|
|
151
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
152
|
+
hourly_pages: "hourly_pages";
|
|
153
|
+
}>;
|
|
154
|
+
searchType: z.ZodEnum<{
|
|
155
|
+
readonly WEB: "web";
|
|
156
|
+
readonly IMAGE: "image";
|
|
157
|
+
readonly VIDEO: "video";
|
|
158
|
+
readonly NEWS: "news";
|
|
159
|
+
readonly DISCOVER: "discover";
|
|
160
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
161
|
+
}>;
|
|
162
|
+
}, z.core.$strict>>;
|
|
163
|
+
candidateNamespace: z.ZodString;
|
|
164
|
+
candidateVersion: z.ZodNumber;
|
|
165
|
+
}, z.core.$strict>;
|
|
166
|
+
}, z.core.$strict>;
|
|
167
|
+
export declare const siteVersionCandidateRequestSchema: z.ZodObject<{
|
|
168
|
+
version: z.ZodNumber;
|
|
169
|
+
identity: z.ZodObject<{
|
|
170
|
+
siteId: z.ZodString;
|
|
171
|
+
userId: z.ZodString;
|
|
172
|
+
teamId: z.ZodUnion<readonly [z.ZodUUID, z.ZodString]>;
|
|
173
|
+
requestedUrl: z.ZodURL;
|
|
174
|
+
catalogSiteId: z.ZodNumber;
|
|
175
|
+
warehouse: z.ZodString;
|
|
176
|
+
namespace: z.ZodString;
|
|
177
|
+
version: z.ZodNumber;
|
|
178
|
+
revision: z.ZodNumber;
|
|
179
|
+
catalogRevision: z.ZodNumber;
|
|
180
|
+
dataVersion: z.ZodNumber;
|
|
181
|
+
}, z.core.$strict>;
|
|
182
|
+
}, z.core.$strict>;
|
|
183
|
+
export declare const siteVersionCandidateSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
184
|
+
version: z.ZodNumber;
|
|
185
|
+
namespace: z.ZodString;
|
|
186
|
+
requestedUrl: z.ZodURL;
|
|
187
|
+
window: z.ZodObject<{
|
|
188
|
+
startDate: z.ZodISODate;
|
|
189
|
+
endDate: z.ZodISODate;
|
|
190
|
+
}, z.core.$strict>;
|
|
191
|
+
requiredSlices: z.ZodArray<z.ZodObject<{
|
|
192
|
+
table: z.ZodEnum<{
|
|
193
|
+
pages: "pages";
|
|
194
|
+
queries: "queries";
|
|
195
|
+
countries: "countries";
|
|
196
|
+
page_queries: "page_queries";
|
|
197
|
+
dates: "dates";
|
|
198
|
+
search_appearance: "search_appearance";
|
|
199
|
+
search_appearance_pages: "search_appearance_pages";
|
|
200
|
+
search_appearance_queries: "search_appearance_queries";
|
|
201
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
202
|
+
hourly_pages: "hourly_pages";
|
|
203
|
+
}>;
|
|
204
|
+
searchType: z.ZodEnum<{
|
|
205
|
+
readonly WEB: "web";
|
|
206
|
+
readonly IMAGE: "image";
|
|
207
|
+
readonly VIDEO: "video";
|
|
208
|
+
readonly NEWS: "news";
|
|
209
|
+
readonly DISCOVER: "discover";
|
|
210
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
211
|
+
}>;
|
|
212
|
+
}, z.core.$strict>>;
|
|
213
|
+
state: z.ZodLiteral<"collecting">;
|
|
214
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
215
|
+
version: z.ZodNumber;
|
|
216
|
+
namespace: z.ZodString;
|
|
217
|
+
requestedUrl: z.ZodURL;
|
|
218
|
+
window: z.ZodObject<{
|
|
219
|
+
startDate: z.ZodISODate;
|
|
220
|
+
endDate: z.ZodISODate;
|
|
221
|
+
}, z.core.$strict>;
|
|
222
|
+
requiredSlices: z.ZodArray<z.ZodObject<{
|
|
223
|
+
table: z.ZodEnum<{
|
|
224
|
+
pages: "pages";
|
|
225
|
+
queries: "queries";
|
|
226
|
+
countries: "countries";
|
|
227
|
+
page_queries: "page_queries";
|
|
228
|
+
dates: "dates";
|
|
229
|
+
search_appearance: "search_appearance";
|
|
230
|
+
search_appearance_pages: "search_appearance_pages";
|
|
231
|
+
search_appearance_queries: "search_appearance_queries";
|
|
232
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
233
|
+
hourly_pages: "hourly_pages";
|
|
234
|
+
}>;
|
|
235
|
+
searchType: z.ZodEnum<{
|
|
236
|
+
readonly WEB: "web";
|
|
237
|
+
readonly IMAGE: "image";
|
|
238
|
+
readonly VIDEO: "video";
|
|
239
|
+
readonly NEWS: "news";
|
|
240
|
+
readonly DISCOVER: "discover";
|
|
241
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
242
|
+
}>;
|
|
243
|
+
}, z.core.$strict>>;
|
|
244
|
+
state: z.ZodLiteral<"verified">;
|
|
245
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
246
|
+
version: z.ZodNumber;
|
|
247
|
+
namespace: z.ZodString;
|
|
248
|
+
requestedUrl: z.ZodURL;
|
|
249
|
+
window: z.ZodObject<{
|
|
250
|
+
startDate: z.ZodISODate;
|
|
251
|
+
endDate: z.ZodISODate;
|
|
252
|
+
}, z.core.$strict>;
|
|
253
|
+
requiredSlices: z.ZodArray<z.ZodObject<{
|
|
254
|
+
table: z.ZodEnum<{
|
|
255
|
+
pages: "pages";
|
|
256
|
+
queries: "queries";
|
|
257
|
+
countries: "countries";
|
|
258
|
+
page_queries: "page_queries";
|
|
259
|
+
dates: "dates";
|
|
260
|
+
search_appearance: "search_appearance";
|
|
261
|
+
search_appearance_pages: "search_appearance_pages";
|
|
262
|
+
search_appearance_queries: "search_appearance_queries";
|
|
263
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
264
|
+
hourly_pages: "hourly_pages";
|
|
265
|
+
}>;
|
|
266
|
+
searchType: z.ZodEnum<{
|
|
267
|
+
readonly WEB: "web";
|
|
268
|
+
readonly IMAGE: "image";
|
|
269
|
+
readonly VIDEO: "video";
|
|
270
|
+
readonly NEWS: "news";
|
|
271
|
+
readonly DISCOVER: "discover";
|
|
272
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
273
|
+
}>;
|
|
274
|
+
}, z.core.$strict>>;
|
|
275
|
+
state: z.ZodLiteral<"active">;
|
|
276
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
277
|
+
version: z.ZodNumber;
|
|
278
|
+
namespace: z.ZodString;
|
|
279
|
+
requestedUrl: z.ZodURL;
|
|
280
|
+
window: z.ZodObject<{
|
|
281
|
+
startDate: z.ZodISODate;
|
|
282
|
+
endDate: z.ZodISODate;
|
|
283
|
+
}, z.core.$strict>;
|
|
284
|
+
requiredSlices: z.ZodArray<z.ZodObject<{
|
|
285
|
+
table: z.ZodEnum<{
|
|
286
|
+
pages: "pages";
|
|
287
|
+
queries: "queries";
|
|
288
|
+
countries: "countries";
|
|
289
|
+
page_queries: "page_queries";
|
|
290
|
+
dates: "dates";
|
|
291
|
+
search_appearance: "search_appearance";
|
|
292
|
+
search_appearance_pages: "search_appearance_pages";
|
|
293
|
+
search_appearance_queries: "search_appearance_queries";
|
|
294
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
295
|
+
hourly_pages: "hourly_pages";
|
|
296
|
+
}>;
|
|
297
|
+
searchType: z.ZodEnum<{
|
|
298
|
+
readonly WEB: "web";
|
|
299
|
+
readonly IMAGE: "image";
|
|
300
|
+
readonly VIDEO: "video";
|
|
301
|
+
readonly NEWS: "news";
|
|
302
|
+
readonly DISCOVER: "discover";
|
|
303
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
304
|
+
}>;
|
|
305
|
+
}, z.core.$strict>>;
|
|
306
|
+
state: z.ZodLiteral<"aborted">;
|
|
307
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
308
|
+
version: z.ZodNumber;
|
|
309
|
+
namespace: z.ZodString;
|
|
310
|
+
requestedUrl: z.ZodURL;
|
|
311
|
+
window: z.ZodObject<{
|
|
312
|
+
startDate: z.ZodISODate;
|
|
313
|
+
endDate: z.ZodISODate;
|
|
314
|
+
}, z.core.$strict>;
|
|
315
|
+
requiredSlices: z.ZodArray<z.ZodObject<{
|
|
316
|
+
table: z.ZodEnum<{
|
|
317
|
+
pages: "pages";
|
|
318
|
+
queries: "queries";
|
|
319
|
+
countries: "countries";
|
|
320
|
+
page_queries: "page_queries";
|
|
321
|
+
dates: "dates";
|
|
322
|
+
search_appearance: "search_appearance";
|
|
323
|
+
search_appearance_pages: "search_appearance_pages";
|
|
324
|
+
search_appearance_queries: "search_appearance_queries";
|
|
325
|
+
search_appearance_page_queries: "search_appearance_page_queries";
|
|
326
|
+
hourly_pages: "hourly_pages";
|
|
327
|
+
}>;
|
|
328
|
+
searchType: z.ZodEnum<{
|
|
329
|
+
readonly WEB: "web";
|
|
330
|
+
readonly IMAGE: "image";
|
|
331
|
+
readonly VIDEO: "video";
|
|
332
|
+
readonly NEWS: "news";
|
|
333
|
+
readonly DISCOVER: "discover";
|
|
334
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
335
|
+
}>;
|
|
336
|
+
}, z.core.$strict>>;
|
|
337
|
+
state: z.ZodLiteral<"failed">;
|
|
338
|
+
failure: z.ZodEnum<{
|
|
339
|
+
"catalog-identity-mismatch": "catalog-identity-mismatch";
|
|
340
|
+
"identity-changed": "identity-changed";
|
|
341
|
+
"host-reserved": "host-reserved";
|
|
342
|
+
"not-eligible": "not-eligible";
|
|
343
|
+
"property-unavailable": "property-unavailable";
|
|
344
|
+
"catalog-unavailable": "catalog-unavailable";
|
|
345
|
+
"provisioning-incomplete": "provisioning-incomplete";
|
|
346
|
+
"coverage-incomplete": "coverage-incomplete";
|
|
347
|
+
"candidate-aborted": "candidate-aborted";
|
|
348
|
+
"candidate-failed": "candidate-failed";
|
|
349
|
+
}>;
|
|
350
|
+
}, z.core.$strict>], "state">;
|
|
351
|
+
export declare const siteVersionIdentityResponseSchema: z.ZodObject<{
|
|
352
|
+
identity: z.ZodObject<{
|
|
353
|
+
siteId: z.ZodString;
|
|
354
|
+
userId: z.ZodString;
|
|
355
|
+
teamId: z.ZodUnion<readonly [z.ZodUUID, z.ZodString]>;
|
|
356
|
+
requestedUrl: z.ZodURL;
|
|
357
|
+
catalogSiteId: z.ZodNumber;
|
|
358
|
+
warehouse: z.ZodString;
|
|
359
|
+
namespace: z.ZodString;
|
|
360
|
+
version: z.ZodNumber;
|
|
361
|
+
revision: z.ZodNumber;
|
|
362
|
+
catalogRevision: z.ZodNumber;
|
|
363
|
+
dataVersion: z.ZodNumber;
|
|
364
|
+
}, z.core.$strict>;
|
|
365
|
+
coverage: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
366
|
+
_tag: z.ZodLiteral<"legacy">;
|
|
367
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
368
|
+
_tag: z.ZodLiteral<"verified">;
|
|
369
|
+
window: z.ZodObject<{
|
|
370
|
+
startDate: z.ZodISODate;
|
|
371
|
+
endDate: z.ZodISODate;
|
|
372
|
+
}, z.core.$strict>;
|
|
373
|
+
}, z.core.$strict>], "_tag">;
|
|
374
|
+
}, z.core.$strict>;
|
|
375
|
+
export type SiteVersionIdentity = z.infer<typeof siteVersionIdentitySchema>;
|
|
376
|
+
export type SiteVersionIdentityResponse = z.infer<typeof siteVersionIdentityResponseSchema>;
|
|
377
|
+
export type SiteVersionPreview = z.infer<typeof siteVersionPreviewSchema>;
|
|
378
|
+
export type SiteVersionCandidate = z.infer<typeof siteVersionCandidateSchema>;
|
|
379
|
+
export type SiteVersionWindow = z.infer<typeof siteVersionWindowSchema>;
|
|
380
|
+
export type SiteVersionSlice = z.infer<typeof siteVersionSliceSchema>;
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import { searchTypeSchema } from "./schemas.mjs";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
const registeredUrl = z.url().refine((value) => {
|
|
4
|
+
const url = new URL(value);
|
|
5
|
+
return ["https:", "http:"].includes(url.protocol) && !url.username && !url.password && !url.hash && !url.search && url.pathname === "/";
|
|
6
|
+
}, { message: "Use an HTTP or HTTPS host URL without a path, query, or fragment." });
|
|
7
|
+
const siteVersionIdentitySchema = z.strictObject({
|
|
8
|
+
siteId: z.string().regex(/^s_[\w-]+$/),
|
|
9
|
+
userId: z.string().regex(/^u_[\w-]+$/),
|
|
10
|
+
teamId: z.union([z.uuid(), z.string().regex(/^t_[\w-]+$/)]),
|
|
11
|
+
requestedUrl: registeredUrl,
|
|
12
|
+
catalogSiteId: z.number().int().positive(),
|
|
13
|
+
warehouse: z.string().min(1),
|
|
14
|
+
namespace: z.string().regex(/^[a-z][a-z0-9_]*$/),
|
|
15
|
+
version: z.number().int().nonnegative(),
|
|
16
|
+
revision: z.number().int().nonnegative(),
|
|
17
|
+
catalogRevision: z.number().int().nonnegative(),
|
|
18
|
+
dataVersion: z.number().int().nonnegative()
|
|
19
|
+
});
|
|
20
|
+
const siteVersionWindowSchema = z.strictObject({
|
|
21
|
+
startDate: z.iso.date(),
|
|
22
|
+
endDate: z.iso.date()
|
|
23
|
+
}).refine((window) => {
|
|
24
|
+
return (Date.parse(window.endDate) - Date.parse(window.startDate)) / 864e5 >= 0;
|
|
25
|
+
}, { message: "The end date must follow or equal the start date." });
|
|
26
|
+
const collectionWindow = siteVersionWindowSchema.refine((window) => (Date.parse(window.endDate) - Date.parse(window.startDate)) / 864e5 < 56, { message: "The collection window must contain 1 to 56 days." });
|
|
27
|
+
const reportWindow = siteVersionWindowSchema.refine((window) => (Date.parse(window.endDate) - Date.parse(window.startDate)) / 864e5 === 27, { message: "The report window must contain 28 days." });
|
|
28
|
+
const siteVersionSliceSchema = z.strictObject({
|
|
29
|
+
table: z.enum([
|
|
30
|
+
"dates",
|
|
31
|
+
"pages",
|
|
32
|
+
"queries",
|
|
33
|
+
"countries",
|
|
34
|
+
"page_queries",
|
|
35
|
+
"search_appearance",
|
|
36
|
+
"search_appearance_pages",
|
|
37
|
+
"search_appearance_queries",
|
|
38
|
+
"search_appearance_page_queries",
|
|
39
|
+
"hourly_pages"
|
|
40
|
+
]),
|
|
41
|
+
searchType: searchTypeSchema
|
|
42
|
+
});
|
|
43
|
+
const siteVersionPreviewRequestSchema = z.strictObject({
|
|
44
|
+
requestedUrl: registeredUrl,
|
|
45
|
+
catalogSiteId: z.number().int().positive(),
|
|
46
|
+
window: reportWindow
|
|
47
|
+
});
|
|
48
|
+
const eligible = z.strictObject({
|
|
49
|
+
_tag: z.literal("eligible"),
|
|
50
|
+
identity: siteVersionIdentitySchema,
|
|
51
|
+
requestedUrl: registeredUrl,
|
|
52
|
+
window: collectionWindow,
|
|
53
|
+
requiredSlices: z.array(siteVersionSliceSchema).min(1),
|
|
54
|
+
candidateNamespace: z.string().regex(/^[a-z][a-z0-9_]*$/),
|
|
55
|
+
candidateVersion: z.number().int().positive()
|
|
56
|
+
});
|
|
57
|
+
const siteVersionRefusalSchema = z.enum([
|
|
58
|
+
"catalog-identity-mismatch",
|
|
59
|
+
"identity-changed",
|
|
60
|
+
"host-reserved",
|
|
61
|
+
"not-eligible",
|
|
62
|
+
"property-unavailable",
|
|
63
|
+
"catalog-unavailable",
|
|
64
|
+
"provisioning-incomplete",
|
|
65
|
+
"coverage-incomplete",
|
|
66
|
+
"candidate-aborted",
|
|
67
|
+
"candidate-failed"
|
|
68
|
+
]);
|
|
69
|
+
const siteVersionPreviewSchema = z.discriminatedUnion("_tag", [eligible, z.strictObject({
|
|
70
|
+
_tag: z.literal("blocked"),
|
|
71
|
+
reason: siteVersionRefusalSchema
|
|
72
|
+
})]);
|
|
73
|
+
const siteVersionBeginRequestSchema = z.strictObject({ preview: eligible });
|
|
74
|
+
const siteVersionCandidateRequestSchema = z.strictObject({
|
|
75
|
+
version: z.number().int().positive(),
|
|
76
|
+
identity: siteVersionIdentitySchema
|
|
77
|
+
});
|
|
78
|
+
const candidate = z.strictObject({
|
|
79
|
+
version: z.number().int().positive(),
|
|
80
|
+
namespace: z.string().regex(/^[a-z][a-z0-9_]*$/),
|
|
81
|
+
requestedUrl: registeredUrl,
|
|
82
|
+
window: collectionWindow,
|
|
83
|
+
requiredSlices: z.array(siteVersionSliceSchema).min(1)
|
|
84
|
+
});
|
|
85
|
+
const siteVersionCandidateSchema = z.discriminatedUnion("state", [
|
|
86
|
+
candidate.extend({ state: z.literal("collecting") }),
|
|
87
|
+
candidate.extend({ state: z.literal("verified") }),
|
|
88
|
+
candidate.extend({ state: z.literal("active") }),
|
|
89
|
+
candidate.extend({ state: z.literal("aborted") }),
|
|
90
|
+
candidate.extend({
|
|
91
|
+
state: z.literal("failed"),
|
|
92
|
+
failure: siteVersionRefusalSchema
|
|
93
|
+
})
|
|
94
|
+
]);
|
|
95
|
+
const siteVersionIdentityResponseSchema = z.strictObject({
|
|
96
|
+
identity: siteVersionIdentitySchema,
|
|
97
|
+
coverage: z.discriminatedUnion("_tag", [z.strictObject({ _tag: z.literal("legacy") }), z.strictObject({
|
|
98
|
+
_tag: z.literal("verified"),
|
|
99
|
+
window: siteVersionWindowSchema
|
|
100
|
+
})])
|
|
101
|
+
});
|
|
102
|
+
export { siteVersionBeginRequestSchema, siteVersionCandidateRequestSchema, siteVersionCandidateSchema, siteVersionIdentityResponseSchema, siteVersionIdentitySchema, siteVersionPreviewRequestSchema, siteVersionPreviewSchema, siteVersionRefusalSchema, siteVersionSliceSchema, siteVersionWindowSchema };
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { CompatibleResponseSchema } from "./http-core.mjs";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
export declare const analyticsCoverageQueryV1Schema: z.ZodObject<{
|
|
4
|
+
startDate: z.ZodISODate;
|
|
5
|
+
endDate: z.ZodISODate;
|
|
6
|
+
comparisonStartDate: z.ZodOptional<z.ZodISODate>;
|
|
7
|
+
comparisonEndDate: z.ZodOptional<z.ZodISODate>;
|
|
8
|
+
searchType: z.ZodDefault<z.ZodEnum<{
|
|
9
|
+
readonly WEB: "web";
|
|
10
|
+
readonly IMAGE: "image";
|
|
11
|
+
readonly VIDEO: "video";
|
|
12
|
+
readonly NEWS: "news";
|
|
13
|
+
readonly DISCOVER: "discover";
|
|
14
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
15
|
+
}>>;
|
|
16
|
+
}, z.core.$strict>;
|
|
17
|
+
export declare const analyticsCoverageV1Schemas: CompatibleResponseSchema<z.ZodObject<{
|
|
18
|
+
readonly searchType: z.ZodEnum<{
|
|
19
|
+
readonly WEB: "web";
|
|
20
|
+
readonly IMAGE: "image";
|
|
21
|
+
readonly VIDEO: "video";
|
|
22
|
+
readonly NEWS: "news";
|
|
23
|
+
readonly DISCOVER: "discover";
|
|
24
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
25
|
+
}>;
|
|
26
|
+
readonly current: z.ZodObject<{
|
|
27
|
+
readonly startDate: z.ZodISODate;
|
|
28
|
+
readonly endDate: z.ZodISODate;
|
|
29
|
+
readonly complete: z.ZodBoolean;
|
|
30
|
+
}, z.core.$strip>;
|
|
31
|
+
readonly comparison: z.ZodNullable<z.ZodObject<{
|
|
32
|
+
readonly startDate: z.ZodISODate;
|
|
33
|
+
readonly endDate: z.ZodISODate;
|
|
34
|
+
readonly complete: z.ZodBoolean;
|
|
35
|
+
}, z.core.$strip>>;
|
|
36
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
37
|
+
readonly searchType: z.ZodEnum<{
|
|
38
|
+
readonly WEB: "web";
|
|
39
|
+
readonly IMAGE: "image";
|
|
40
|
+
readonly VIDEO: "video";
|
|
41
|
+
readonly NEWS: "news";
|
|
42
|
+
readonly DISCOVER: "discover";
|
|
43
|
+
readonly GOOGLE_NEWS: "googleNews";
|
|
44
|
+
}>;
|
|
45
|
+
readonly current: z.ZodObject<{
|
|
46
|
+
readonly startDate: z.ZodISODate;
|
|
47
|
+
readonly endDate: z.ZodISODate;
|
|
48
|
+
readonly complete: z.ZodBoolean;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
readonly comparison: z.ZodNullable<z.ZodObject<{
|
|
51
|
+
readonly startDate: z.ZodISODate;
|
|
52
|
+
readonly endDate: z.ZodISODate;
|
|
53
|
+
readonly complete: z.ZodBoolean;
|
|
54
|
+
}, z.core.$strip>>;
|
|
55
|
+
}, z.core.$strip>>;
|
|
56
|
+
export type AnalyticsCoverageV1 = z.output<typeof analyticsCoverageV1Schemas.client>;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { searchTypeSchema } from "../schemas.mjs";
|
|
2
|
+
import { defineResponseObject } from "./http-core.mjs";
|
|
3
|
+
import { z } from "zod";
|
|
4
|
+
const analyticsCoverageQueryV1Schema = z.strictObject({
|
|
5
|
+
startDate: z.iso.date(),
|
|
6
|
+
endDate: z.iso.date(),
|
|
7
|
+
comparisonStartDate: z.iso.date().optional(),
|
|
8
|
+
comparisonEndDate: z.iso.date().optional(),
|
|
9
|
+
searchType: searchTypeSchema.default("web")
|
|
10
|
+
}).refine((input) => input.startDate <= input.endDate, "The start date must precede the end date.").refine((input) => input.comparisonStartDate === void 0 === (input.comparisonEndDate === void 0), "Provide both comparison dates.").refine((input) => !input.comparisonStartDate || input.comparisonStartDate <= input.comparisonEndDate, "The comparison start date must precede the end date.");
|
|
11
|
+
const window = defineResponseObject({
|
|
12
|
+
startDate: z.iso.date(),
|
|
13
|
+
endDate: z.iso.date(),
|
|
14
|
+
complete: z.boolean()
|
|
15
|
+
});
|
|
16
|
+
const analyticsCoverageV1Schemas = defineResponseObject({
|
|
17
|
+
searchType: searchTypeSchema,
|
|
18
|
+
current: window.producer,
|
|
19
|
+
comparison: window.producer.nullable()
|
|
20
|
+
}, {
|
|
21
|
+
searchType: searchTypeSchema,
|
|
22
|
+
current: window.client,
|
|
23
|
+
comparison: window.client.nullable()
|
|
24
|
+
});
|
|
25
|
+
export { analyticsCoverageQueryV1Schema, analyticsCoverageV1Schemas };
|
package/dist/v1/bing-sites.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { bingCnameVerificationV1Schema } from "./bing.mjs";
|
|
2
1
|
import { defineResponseObject } from "./http-core.mjs";
|
|
2
|
+
import { bingCnameVerificationV1Schema } from "./bing.mjs";
|
|
3
3
|
import { z } from "zod";
|
|
4
4
|
const isoDateTime = z.iso.datetime();
|
|
5
5
|
const publicSiteId = z.string().regex(/^s_[\w-]+$/);
|
package/dist/v1/http-core.d.mts
CHANGED
|
@@ -11,7 +11,7 @@ export declare const HTTP_V1_CREDENTIAL_SCOPES: {
|
|
|
11
11
|
readonly user_key: readonly ["users:read", "users:write", "sites:read", "sites:write", "analytics:read", "analytics:execute", "indexing:read", "indexing:write", "sitemaps:read", "sitemaps:write", "settings:read", "settings:write", "realtime:connect"];
|
|
12
12
|
readonly partner_key: readonly ["users:read", "users:write", "sites:read", "sites:write", "analytics:read", "analytics:execute", "indexing:read", "indexing:write", "sitemaps:read", "sitemaps:write", "settings:read", "settings:write", "realtime:connect", "teams:read", "teams:write"];
|
|
13
13
|
};
|
|
14
|
-
export declare const HTTP_V1_ERROR_CODES: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "site_not_found", "api_key_not_found", "api_key_limit_reached", "rate_limited", "realtime_unavailable", "internal_error", "contract_violation"];
|
|
14
|
+
export declare const HTTP_V1_ERROR_CODES: readonly ["invalid_request", "unauthorized", "forbidden", "user_not_found", "site_not_found", "api_key_not_found", "api_key_limit_reached", "rate_limited", "conflict", "service_unavailable", "realtime_unavailable", "internal_error", "contract_violation"];
|
|
15
15
|
export type HttpV1SurfaceName = HttpV1RouteSurfaceName;
|
|
16
16
|
export type HttpV1Method = HttpV1RouteMethod;
|
|
17
17
|
export type HttpV1Credential = typeof HTTP_V1_CREDENTIALS[number];
|