@gscdump/contracts 1.5.3 → 1.5.4
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/v1/browser.d.mts +30 -0
- package/dist/v1/browser.mjs +8 -0
- package/dist/v1/operations.d.mts +42 -12
- package/dist/v1/operations.mjs +5 -9
- package/package.json +1 -1
package/dist/v1/browser.d.mts
CHANGED
|
@@ -98,6 +98,36 @@ declare function createGscdumpV1BrowserSchemas(realtimeSchemas?: RealtimeV1Schem
|
|
|
98
98
|
readonly queryMs: z.ZodNumber;
|
|
99
99
|
}, z.core.$strip>;
|
|
100
100
|
}, z.core.$strip>>;
|
|
101
|
+
keywordEnrichmentRequest: z.ZodObject<{
|
|
102
|
+
keywords: z.ZodArray<z.ZodString>;
|
|
103
|
+
}, z.core.$strict>;
|
|
104
|
+
keywordEnrichmentResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
105
|
+
data: z.ZodObject<{
|
|
106
|
+
readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
107
|
+
difficulty: z.ZodNullable<z.ZodNumber>;
|
|
108
|
+
searchVolume: z.ZodNullable<z.ZodNumber>;
|
|
109
|
+
cpc: z.ZodNullable<z.ZodNumber>;
|
|
110
|
+
}, z.core.$loose>>;
|
|
111
|
+
}, z.core.$strip>;
|
|
112
|
+
meta: z.ZodObject<{
|
|
113
|
+
readonly requestId: z.ZodString;
|
|
114
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
115
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
116
|
+
}, z.core.$strip>;
|
|
117
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
118
|
+
data: z.ZodObject<{
|
|
119
|
+
readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
120
|
+
difficulty: z.ZodNullable<z.ZodNumber>;
|
|
121
|
+
searchVolume: z.ZodNullable<z.ZodNumber>;
|
|
122
|
+
cpc: z.ZodNullable<z.ZodNumber>;
|
|
123
|
+
}, z.core.$loose>>;
|
|
124
|
+
}, z.core.$strip>;
|
|
125
|
+
meta: z.ZodObject<{
|
|
126
|
+
readonly requestId: z.ZodString;
|
|
127
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
128
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
129
|
+
}, z.core.$strip>;
|
|
130
|
+
}, z.core.$strip>>;
|
|
101
131
|
lifecycleResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
102
132
|
data: z.ZodObject<{
|
|
103
133
|
readonly userId: z.ZodString;
|
package/dist/v1/browser.mjs
CHANGED
|
@@ -118,6 +118,12 @@ function createGscdumpV1BrowserSchemas(realtimeSchemas = createRealtimeV1Schemas
|
|
|
118
118
|
version: z.literal("1.0")
|
|
119
119
|
});
|
|
120
120
|
const lifecycleResponse = defineSuccessResponse(lifecycleResponseSchemas(realtimeSchemas), partnerResponseMeta);
|
|
121
|
+
const keywordEnrichmentRequest = z.strictObject({ keywords: z.array(z.string().min(1)).min(1).max(500) });
|
|
122
|
+
const keywordEnrichmentResponse = defineSuccessResponse(defineResponseObject({ metrics: z.record(z.string(), z.object({
|
|
123
|
+
difficulty: z.number().nullable(),
|
|
124
|
+
searchVolume: z.number().nullable(),
|
|
125
|
+
cpc: z.number().nullable()
|
|
126
|
+
}).loose()) }), partnerResponseMeta);
|
|
121
127
|
const dimensions = GSCDUMP_V1_ANALYTICS_DIMENSIONS;
|
|
122
128
|
const metrics = [
|
|
123
129
|
"clicks",
|
|
@@ -210,6 +216,8 @@ function createGscdumpV1BrowserSchemas(realtimeSchemas = createRealtimeV1Schemas
|
|
|
210
216
|
sourceKind: z.enum(["row", "sql"]),
|
|
211
217
|
queryMs: z.number().nonnegative()
|
|
212
218
|
})),
|
|
219
|
+
keywordEnrichmentRequest,
|
|
220
|
+
keywordEnrichmentResponse,
|
|
213
221
|
lifecycleResponse,
|
|
214
222
|
ticketRequest: realtimeSchemas.ticketRequest,
|
|
215
223
|
ticketResponse: realtimeSchemas.ticketResponseClient
|
package/dist/v1/operations.d.mts
CHANGED
|
@@ -736,12 +736,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
736
736
|
googleNews: "googleNews";
|
|
737
737
|
}>>;
|
|
738
738
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
739
|
-
date: "date";
|
|
740
739
|
page: "page";
|
|
741
740
|
query: "query";
|
|
742
741
|
queryCanonical: "queryCanonical";
|
|
743
742
|
country: "country";
|
|
744
743
|
device: "device";
|
|
744
|
+
date: "date";
|
|
745
745
|
searchAppearance: "searchAppearance";
|
|
746
746
|
hour: "hour";
|
|
747
747
|
}>>;
|
|
@@ -756,12 +756,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
756
756
|
googleNews: "googleNews";
|
|
757
757
|
}>>;
|
|
758
758
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
759
|
-
date: "date";
|
|
760
759
|
page: "page";
|
|
761
760
|
query: "query";
|
|
762
761
|
queryCanonical: "queryCanonical";
|
|
763
762
|
country: "country";
|
|
764
763
|
device: "device";
|
|
764
|
+
date: "date";
|
|
765
765
|
searchAppearance: "searchAppearance";
|
|
766
766
|
hour: "hour";
|
|
767
767
|
}>>;
|
|
@@ -893,12 +893,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
893
893
|
googleNews: "googleNews";
|
|
894
894
|
}>>;
|
|
895
895
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
896
|
-
date: "date";
|
|
897
896
|
page: "page";
|
|
898
897
|
query: "query";
|
|
899
898
|
queryCanonical: "queryCanonical";
|
|
900
899
|
country: "country";
|
|
901
900
|
device: "device";
|
|
901
|
+
date: "date";
|
|
902
902
|
searchAppearance: "searchAppearance";
|
|
903
903
|
hour: "hour";
|
|
904
904
|
}>>;
|
|
@@ -913,12 +913,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
913
913
|
googleNews: "googleNews";
|
|
914
914
|
}>>;
|
|
915
915
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
916
|
-
date: "date";
|
|
917
916
|
page: "page";
|
|
918
917
|
query: "query";
|
|
919
918
|
queryCanonical: "queryCanonical";
|
|
920
919
|
country: "country";
|
|
921
920
|
device: "device";
|
|
921
|
+
date: "date";
|
|
922
922
|
searchAppearance: "searchAppearance";
|
|
923
923
|
hour: "hour";
|
|
924
924
|
}>>;
|
|
@@ -1021,12 +1021,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
1021
1021
|
}, z.core.$strip>>;
|
|
1022
1022
|
analyticsRowsRequest: z.ZodObject<{
|
|
1023
1023
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
1024
|
-
date: "date";
|
|
1025
1024
|
page: "page";
|
|
1026
1025
|
query: "query";
|
|
1027
1026
|
queryCanonical: "queryCanonical";
|
|
1028
1027
|
country: "country";
|
|
1029
1028
|
device: "device";
|
|
1029
|
+
date: "date";
|
|
1030
1030
|
searchAppearance: "searchAppearance";
|
|
1031
1031
|
hour: "hour";
|
|
1032
1032
|
}>>;
|
|
@@ -1841,6 +1841,36 @@ declare function createGscdumpV1Protocol(): {
|
|
|
1841
1841
|
readonly version: z.ZodLiteral<"1.0">;
|
|
1842
1842
|
}, z.core.$strip>;
|
|
1843
1843
|
}, z.core.$strip>>;
|
|
1844
|
+
keywordEnrichmentRequest: z.ZodObject<{
|
|
1845
|
+
keywords: z.ZodArray<z.ZodString>;
|
|
1846
|
+
}, z.core.$strict>;
|
|
1847
|
+
keywordEnrichmentResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
1848
|
+
data: z.ZodObject<{
|
|
1849
|
+
readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
1850
|
+
difficulty: z.ZodNullable<z.ZodNumber>;
|
|
1851
|
+
searchVolume: z.ZodNullable<z.ZodNumber>;
|
|
1852
|
+
cpc: z.ZodNullable<z.ZodNumber>;
|
|
1853
|
+
}, z.core.$loose>>;
|
|
1854
|
+
}, z.core.$strip>;
|
|
1855
|
+
meta: z.ZodObject<{
|
|
1856
|
+
readonly requestId: z.ZodString;
|
|
1857
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
1858
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
1859
|
+
}, z.core.$strip>;
|
|
1860
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
1861
|
+
data: z.ZodObject<{
|
|
1862
|
+
readonly metrics: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
1863
|
+
difficulty: z.ZodNullable<z.ZodNumber>;
|
|
1864
|
+
searchVolume: z.ZodNullable<z.ZodNumber>;
|
|
1865
|
+
cpc: z.ZodNullable<z.ZodNumber>;
|
|
1866
|
+
}, z.core.$loose>>;
|
|
1867
|
+
}, z.core.$strip>;
|
|
1868
|
+
meta: z.ZodObject<{
|
|
1869
|
+
readonly requestId: z.ZodString;
|
|
1870
|
+
readonly surface: z.ZodLiteral<"partner">;
|
|
1871
|
+
readonly version: z.ZodLiteral<"1.0">;
|
|
1872
|
+
}, z.core.$strip>;
|
|
1873
|
+
}, z.core.$strip>>;
|
|
1844
1874
|
lifecycleResponse: CompatibleResponseSchema<z.ZodObject<{
|
|
1845
1875
|
data: z.ZodObject<{
|
|
1846
1876
|
readonly userId: z.ZodString;
|
|
@@ -2155,10 +2185,10 @@ declare function createGscdumpV1Protocol(): {
|
|
|
2155
2185
|
}, z.core.$strip>;
|
|
2156
2186
|
}, z.core.$strip>>;
|
|
2157
2187
|
registerSiteRequest: z.ZodObject<{
|
|
2158
|
-
siteUrl: z.ZodString;
|
|
2159
2188
|
externalSiteId: z.ZodOptional<z.ZodString>;
|
|
2160
2189
|
requestedUrl: z.ZodOptional<z.ZodString>;
|
|
2161
2190
|
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
2191
|
+
siteUrl: z.ZodString;
|
|
2162
2192
|
externalSiteUrl: z.ZodOptional<z.ZodString>;
|
|
2163
2193
|
webhookUrl: z.ZodOptional<z.ZodURL>;
|
|
2164
2194
|
webhookEvents: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
@@ -3482,10 +3512,10 @@ declare function createGscdumpV1Protocol(): {
|
|
|
3482
3512
|
'x-request-id': z.ZodOptional<z.ZodString>;
|
|
3483
3513
|
}, z.core.$strict>;
|
|
3484
3514
|
readonly body: z.ZodObject<{
|
|
3485
|
-
siteUrl: z.ZodString;
|
|
3486
3515
|
externalSiteId: z.ZodOptional<z.ZodString>;
|
|
3487
3516
|
requestedUrl: z.ZodOptional<z.ZodString>;
|
|
3488
3517
|
gscPropertyUrl: z.ZodOptional<z.ZodString>;
|
|
3518
|
+
siteUrl: z.ZodString;
|
|
3489
3519
|
externalSiteUrl: z.ZodOptional<z.ZodString>;
|
|
3490
3520
|
webhookUrl: z.ZodOptional<z.ZodURL>;
|
|
3491
3521
|
webhookEvents: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
@@ -11217,12 +11247,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
11217
11247
|
}, z.core.$strict>;
|
|
11218
11248
|
readonly body: z.ZodObject<{
|
|
11219
11249
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
11220
|
-
date: "date";
|
|
11221
11250
|
page: "page";
|
|
11222
11251
|
query: "query";
|
|
11223
11252
|
queryCanonical: "queryCanonical";
|
|
11224
11253
|
country: "country";
|
|
11225
11254
|
device: "device";
|
|
11255
|
+
date: "date";
|
|
11226
11256
|
searchAppearance: "searchAppearance";
|
|
11227
11257
|
hour: "hour";
|
|
11228
11258
|
}>>;
|
|
@@ -11420,12 +11450,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
11420
11450
|
googleNews: "googleNews";
|
|
11421
11451
|
}>>;
|
|
11422
11452
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
11423
|
-
date: "date";
|
|
11424
11453
|
page: "page";
|
|
11425
11454
|
query: "query";
|
|
11426
11455
|
queryCanonical: "queryCanonical";
|
|
11427
11456
|
country: "country";
|
|
11428
11457
|
device: "device";
|
|
11458
|
+
date: "date";
|
|
11429
11459
|
searchAppearance: "searchAppearance";
|
|
11430
11460
|
hour: "hour";
|
|
11431
11461
|
}>>;
|
|
@@ -11440,12 +11470,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
11440
11470
|
googleNews: "googleNews";
|
|
11441
11471
|
}>>;
|
|
11442
11472
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
11443
|
-
date: "date";
|
|
11444
11473
|
page: "page";
|
|
11445
11474
|
query: "query";
|
|
11446
11475
|
queryCanonical: "queryCanonical";
|
|
11447
11476
|
country: "country";
|
|
11448
11477
|
device: "device";
|
|
11478
|
+
date: "date";
|
|
11449
11479
|
searchAppearance: "searchAppearance";
|
|
11450
11480
|
hour: "hour";
|
|
11451
11481
|
}>>;
|
|
@@ -11681,12 +11711,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
11681
11711
|
googleNews: "googleNews";
|
|
11682
11712
|
}>>;
|
|
11683
11713
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
11684
|
-
date: "date";
|
|
11685
11714
|
page: "page";
|
|
11686
11715
|
query: "query";
|
|
11687
11716
|
queryCanonical: "queryCanonical";
|
|
11688
11717
|
country: "country";
|
|
11689
11718
|
device: "device";
|
|
11719
|
+
date: "date";
|
|
11690
11720
|
searchAppearance: "searchAppearance";
|
|
11691
11721
|
hour: "hour";
|
|
11692
11722
|
}>>;
|
|
@@ -11701,12 +11731,12 @@ declare function createGscdumpV1Protocol(): {
|
|
|
11701
11731
|
googleNews: "googleNews";
|
|
11702
11732
|
}>>;
|
|
11703
11733
|
dimensions: z.ZodArray<z.ZodEnum<{
|
|
11704
|
-
date: "date";
|
|
11705
11734
|
page: "page";
|
|
11706
11735
|
query: "query";
|
|
11707
11736
|
queryCanonical: "queryCanonical";
|
|
11708
11737
|
country: "country";
|
|
11709
11738
|
device: "device";
|
|
11739
|
+
date: "date";
|
|
11710
11740
|
searchAppearance: "searchAppearance";
|
|
11711
11741
|
hour: "hour";
|
|
11712
11742
|
}>>;
|
package/dist/v1/operations.mjs
CHANGED
|
@@ -52,7 +52,7 @@ function createGscdumpV1Protocol() {
|
|
|
52
52
|
});
|
|
53
53
|
const requestHeaders = z.strictObject({ "x-request-id": realtimeSchemas.publicRequestId.optional() });
|
|
54
54
|
const errorEnvelope = errorEnvelopeSchemas(HTTP_V1_ERROR_CODES, realtimeSchemas.publicRequestId);
|
|
55
|
-
const { analyticsRowsRequest, analyticsRowsResponse, lifecycleResponse } = browserSchemas;
|
|
55
|
+
const { analyticsRowsRequest, analyticsRowsResponse, keywordEnrichmentRequest, keywordEnrichmentResponse, lifecycleResponse } = browserSchemas;
|
|
56
56
|
const dimensions = GSCDUMP_V1_ANALYTICS_DIMENSIONS;
|
|
57
57
|
const analyticsMeta = defineResponseObject({
|
|
58
58
|
requestId: realtimeSchemas.publicRequestId,
|
|
@@ -564,12 +564,6 @@ function createGscdumpV1Protocol() {
|
|
|
564
564
|
sources: z.array(z.string()),
|
|
565
565
|
rows: z.array(z.record(z.string(), z.json()))
|
|
566
566
|
}), partnerResponseMeta);
|
|
567
|
-
const enrichKeywordsRequest = z.strictObject({ keywords: z.array(z.string().min(1)).min(1).max(500) });
|
|
568
|
-
const enrichKeywordsResponse = defineSuccessResponse(defineResponseObject({ metrics: z.record(z.string(), z.object({
|
|
569
|
-
difficulty: z.number().nullable(),
|
|
570
|
-
searchVolume: z.number().nullable(),
|
|
571
|
-
cpc: z.number().nullable()
|
|
572
|
-
}).loose()) }), partnerResponseMeta);
|
|
573
567
|
const responseStreamHead = defineResponseObject({
|
|
574
568
|
streamId: realtimeSchemas.streamId,
|
|
575
569
|
sequence: realtimeSchemas.sequence
|
|
@@ -3807,9 +3801,9 @@ function createGscdumpV1Protocol() {
|
|
|
3807
3801
|
params: null,
|
|
3808
3802
|
query: null,
|
|
3809
3803
|
headers: requestHeaders,
|
|
3810
|
-
body:
|
|
3804
|
+
body: keywordEnrichmentRequest
|
|
3811
3805
|
},
|
|
3812
|
-
responses: { 200:
|
|
3806
|
+
responses: { 200: keywordEnrichmentResponse },
|
|
3813
3807
|
errors: partnerUserErrors,
|
|
3814
3808
|
errorResponse: errorEnvelopeSchemas(partnerUserErrors, realtimeSchemas.publicRequestId),
|
|
3815
3809
|
resources: {
|
|
@@ -4251,6 +4245,8 @@ function createGscdumpV1Protocol() {
|
|
|
4251
4245
|
indexingTransitionsResponse,
|
|
4252
4246
|
indexingUrlsQuery,
|
|
4253
4247
|
indexingUrlsResponse,
|
|
4248
|
+
keywordEnrichmentRequest,
|
|
4249
|
+
keywordEnrichmentResponse,
|
|
4254
4250
|
lifecycleResponse,
|
|
4255
4251
|
registerSiteRequest,
|
|
4256
4252
|
sitemapChangesQuery,
|