@gscdump/contracts 0.15.0 → 0.17.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/index.d.mts +282 -1
- package/dist/index.mjs +67 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -140,6 +140,7 @@ declare const partnerRoutes: {
|
|
|
140
140
|
readonly indexing: (siteId: string) => string;
|
|
141
141
|
readonly indexingUrls: (siteId: string) => string;
|
|
142
142
|
readonly indexingDiagnostics: (siteId: string) => string;
|
|
143
|
+
readonly indexingInspect: (siteId: string) => string;
|
|
143
144
|
readonly recoverPermission: (siteId: string) => string;
|
|
144
145
|
readonly canonicalMismatches: (siteId: string) => string;
|
|
145
146
|
readonly topAssociation: (siteId: string) => string;
|
|
@@ -184,11 +185,26 @@ declare const analyticsRoutes: {
|
|
|
184
185
|
readonly inspectionHistory: (siteId: string, hash: string) => string;
|
|
185
186
|
readonly indexingUrls: (siteId: string) => string;
|
|
186
187
|
readonly indexingDiagnostics: (siteId: string) => string;
|
|
188
|
+
readonly indexingInspect: (siteId: string) => string;
|
|
187
189
|
readonly countries: (siteId: string) => string;
|
|
188
190
|
readonly searchAppearance: (siteId: string) => string;
|
|
189
191
|
};
|
|
190
192
|
};
|
|
191
193
|
declare const builderStateSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
194
|
+
/**
|
|
195
|
+
* GSC search-type slice validator. Mirrors the {@link GscSearchType} union
|
|
196
|
+
* and the `SearchTypes` constants in `gscdump/query`. Used by consumers
|
|
197
|
+
* routing requests across slices (web | discover | news | googleNews | image |
|
|
198
|
+
* video) to validate untrusted input before threading it to the engine.
|
|
199
|
+
*/
|
|
200
|
+
declare const searchTypeSchema: z.ZodEnum<{
|
|
201
|
+
web: "web";
|
|
202
|
+
image: "image";
|
|
203
|
+
video: "video";
|
|
204
|
+
news: "news";
|
|
205
|
+
discover: "discover";
|
|
206
|
+
googleNews: "googleNews";
|
|
207
|
+
}>;
|
|
192
208
|
declare const gscComparisonFilterSchema: z.ZodEnum<{
|
|
193
209
|
new: "new";
|
|
194
210
|
lost: "lost";
|
|
@@ -412,6 +428,117 @@ declare const indexingDiagnosticsSchema: z.ZodObject<{
|
|
|
412
428
|
siteUrl: z.ZodString;
|
|
413
429
|
}, z.core.$loose>;
|
|
414
430
|
}, z.core.$loose>;
|
|
431
|
+
declare const indexingInspectRequestSchema: z.ZodObject<{
|
|
432
|
+
urls: z.ZodArray<z.ZodString>;
|
|
433
|
+
}, z.core.$strip>;
|
|
434
|
+
declare const indexingInspectResultSchema: z.ZodObject<{
|
|
435
|
+
url: z.ZodString;
|
|
436
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
437
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
438
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
439
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
440
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
441
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
442
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
443
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
444
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
445
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
446
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
447
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
448
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
449
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
450
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
451
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
452
|
+
}, z.core.$loose>;
|
|
453
|
+
declare const indexingInspectResponseSchema: z.ZodObject<{
|
|
454
|
+
siteId: z.ZodString;
|
|
455
|
+
rateLimit: z.ZodObject<{
|
|
456
|
+
reserved: z.ZodNumber;
|
|
457
|
+
remaining: z.ZodNumber;
|
|
458
|
+
limit: z.ZodNumber;
|
|
459
|
+
}, z.core.$loose>;
|
|
460
|
+
results: z.ZodArray<z.ZodObject<{
|
|
461
|
+
url: z.ZodString;
|
|
462
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
463
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
464
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
465
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
466
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
467
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
468
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
469
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
470
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
471
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
472
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
473
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
474
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
475
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
476
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
477
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
478
|
+
}, z.core.$loose>>;
|
|
479
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
480
|
+
url: z.ZodString;
|
|
481
|
+
error: z.ZodString;
|
|
482
|
+
}, z.core.$loose>>;
|
|
483
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
484
|
+
url: z.ZodString;
|
|
485
|
+
reason: z.ZodString;
|
|
486
|
+
}, z.core.$loose>>;
|
|
487
|
+
}, z.core.$loose>;
|
|
488
|
+
declare const indexingInspectRateLimitedSchema: z.ZodObject<{
|
|
489
|
+
error: z.ZodLiteral<"rate_limited">;
|
|
490
|
+
message: z.ZodString;
|
|
491
|
+
rateLimit: z.ZodObject<{
|
|
492
|
+
reserved: z.ZodLiteral<0>;
|
|
493
|
+
remaining: z.ZodLiteral<0>;
|
|
494
|
+
limit: z.ZodNumber;
|
|
495
|
+
}, z.core.$loose>;
|
|
496
|
+
retryAfterSeconds: z.ZodNumber;
|
|
497
|
+
}, z.core.$loose>;
|
|
498
|
+
declare const indexingInspectAnyResponseSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
499
|
+
siteId: z.ZodString;
|
|
500
|
+
rateLimit: z.ZodObject<{
|
|
501
|
+
reserved: z.ZodNumber;
|
|
502
|
+
remaining: z.ZodNumber;
|
|
503
|
+
limit: z.ZodNumber;
|
|
504
|
+
}, z.core.$loose>;
|
|
505
|
+
results: z.ZodArray<z.ZodObject<{
|
|
506
|
+
url: z.ZodString;
|
|
507
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
508
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
509
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
510
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
511
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
512
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
513
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
514
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
515
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
516
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
517
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
518
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
519
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
520
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
521
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
522
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
523
|
+
}, z.core.$loose>>;
|
|
524
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
525
|
+
url: z.ZodString;
|
|
526
|
+
error: z.ZodString;
|
|
527
|
+
}, z.core.$loose>>;
|
|
528
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
529
|
+
url: z.ZodString;
|
|
530
|
+
reason: z.ZodString;
|
|
531
|
+
}, z.core.$loose>>;
|
|
532
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
533
|
+
error: z.ZodLiteral<"rate_limited">;
|
|
534
|
+
message: z.ZodString;
|
|
535
|
+
rateLimit: z.ZodObject<{
|
|
536
|
+
reserved: z.ZodLiteral<0>;
|
|
537
|
+
remaining: z.ZodLiteral<0>;
|
|
538
|
+
limit: z.ZodNumber;
|
|
539
|
+
}, z.core.$loose>;
|
|
540
|
+
retryAfterSeconds: z.ZodNumber;
|
|
541
|
+
}, z.core.$loose>]>;
|
|
415
542
|
declare const sitemapChangesResponseSchema: z.ZodObject<{
|
|
416
543
|
added: z.ZodArray<z.ZodObject<{
|
|
417
544
|
url: z.ZodString;
|
|
@@ -2112,6 +2239,55 @@ declare const partnerEndpointSchemas: {
|
|
|
2112
2239
|
}, z.core.$loose>;
|
|
2113
2240
|
}, z.core.$loose>;
|
|
2114
2241
|
};
|
|
2242
|
+
readonly analyticsIndexingInspect: {
|
|
2243
|
+
readonly body: z.ZodObject<{
|
|
2244
|
+
urls: z.ZodArray<z.ZodString>;
|
|
2245
|
+
}, z.core.$strip>;
|
|
2246
|
+
readonly response: z.ZodUnion<readonly [z.ZodObject<{
|
|
2247
|
+
siteId: z.ZodString;
|
|
2248
|
+
rateLimit: z.ZodObject<{
|
|
2249
|
+
reserved: z.ZodNumber;
|
|
2250
|
+
remaining: z.ZodNumber;
|
|
2251
|
+
limit: z.ZodNumber;
|
|
2252
|
+
}, z.core.$loose>;
|
|
2253
|
+
results: z.ZodArray<z.ZodObject<{
|
|
2254
|
+
url: z.ZodString;
|
|
2255
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
2256
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
2257
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
2258
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
2259
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
2260
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
2261
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
2262
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
2263
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
2264
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
2265
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
2266
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
2267
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
2268
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
2269
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
2270
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
2271
|
+
}, z.core.$loose>>;
|
|
2272
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
2273
|
+
url: z.ZodString;
|
|
2274
|
+
error: z.ZodString;
|
|
2275
|
+
}, z.core.$loose>>;
|
|
2276
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
2277
|
+
url: z.ZodString;
|
|
2278
|
+
reason: z.ZodString;
|
|
2279
|
+
}, z.core.$loose>>;
|
|
2280
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
2281
|
+
error: z.ZodLiteral<"rate_limited">;
|
|
2282
|
+
message: z.ZodString;
|
|
2283
|
+
rateLimit: z.ZodObject<{
|
|
2284
|
+
reserved: z.ZodLiteral<0>;
|
|
2285
|
+
remaining: z.ZodLiteral<0>;
|
|
2286
|
+
limit: z.ZodNumber;
|
|
2287
|
+
}, z.core.$loose>;
|
|
2288
|
+
retryAfterSeconds: z.ZodNumber;
|
|
2289
|
+
}, z.core.$loose>]>;
|
|
2290
|
+
};
|
|
2115
2291
|
readonly analyticsSitemapChanges: {
|
|
2116
2292
|
readonly response: z.ZodObject<{
|
|
2117
2293
|
added: z.ZodArray<z.ZodObject<{
|
|
@@ -2805,6 +2981,55 @@ declare const partnerEndpointSchemas: {
|
|
|
2805
2981
|
}, z.core.$loose>;
|
|
2806
2982
|
}, z.core.$loose>;
|
|
2807
2983
|
};
|
|
2984
|
+
readonly getIndexingInspect: {
|
|
2985
|
+
readonly body: z.ZodObject<{
|
|
2986
|
+
urls: z.ZodArray<z.ZodString>;
|
|
2987
|
+
}, z.core.$strip>;
|
|
2988
|
+
readonly response: z.ZodUnion<readonly [z.ZodObject<{
|
|
2989
|
+
siteId: z.ZodString;
|
|
2990
|
+
rateLimit: z.ZodObject<{
|
|
2991
|
+
reserved: z.ZodNumber;
|
|
2992
|
+
remaining: z.ZodNumber;
|
|
2993
|
+
limit: z.ZodNumber;
|
|
2994
|
+
}, z.core.$loose>;
|
|
2995
|
+
results: z.ZodArray<z.ZodObject<{
|
|
2996
|
+
url: z.ZodString;
|
|
2997
|
+
verdict: z.ZodNullable<z.ZodString>;
|
|
2998
|
+
coverageState: z.ZodNullable<z.ZodString>;
|
|
2999
|
+
indexingState: z.ZodNullable<z.ZodString>;
|
|
3000
|
+
robotsTxtState: z.ZodNullable<z.ZodString>;
|
|
3001
|
+
pageFetchState: z.ZodNullable<z.ZodString>;
|
|
3002
|
+
lastCrawlTime: z.ZodNullable<z.ZodString>;
|
|
3003
|
+
crawlingUserAgent: z.ZodNullable<z.ZodString>;
|
|
3004
|
+
userCanonical: z.ZodNullable<z.ZodString>;
|
|
3005
|
+
googleCanonical: z.ZodNullable<z.ZodString>;
|
|
3006
|
+
sitemaps: z.ZodNullable<z.ZodString>;
|
|
3007
|
+
referringUrls: z.ZodNullable<z.ZodString>;
|
|
3008
|
+
mobileVerdict: z.ZodNullable<z.ZodString>;
|
|
3009
|
+
mobileIssues: z.ZodNullable<z.ZodString>;
|
|
3010
|
+
richResultsVerdict: z.ZodNullable<z.ZodString>;
|
|
3011
|
+
richResultsItems: z.ZodNullable<z.ZodString>;
|
|
3012
|
+
inspectionResultLink: z.ZodNullable<z.ZodString>;
|
|
3013
|
+
}, z.core.$loose>>;
|
|
3014
|
+
errors: z.ZodArray<z.ZodObject<{
|
|
3015
|
+
url: z.ZodString;
|
|
3016
|
+
error: z.ZodString;
|
|
3017
|
+
}, z.core.$loose>>;
|
|
3018
|
+
skipped: z.ZodArray<z.ZodObject<{
|
|
3019
|
+
url: z.ZodString;
|
|
3020
|
+
reason: z.ZodString;
|
|
3021
|
+
}, z.core.$loose>>;
|
|
3022
|
+
}, z.core.$loose>, z.ZodObject<{
|
|
3023
|
+
error: z.ZodLiteral<"rate_limited">;
|
|
3024
|
+
message: z.ZodString;
|
|
3025
|
+
rateLimit: z.ZodObject<{
|
|
3026
|
+
reserved: z.ZodLiteral<0>;
|
|
3027
|
+
remaining: z.ZodLiteral<0>;
|
|
3028
|
+
limit: z.ZodNumber;
|
|
3029
|
+
}, z.core.$loose>;
|
|
3030
|
+
retryAfterSeconds: z.ZodNumber;
|
|
3031
|
+
}, z.core.$loose>]>;
|
|
3032
|
+
};
|
|
2808
3033
|
readonly getUserSettings: {
|
|
2809
3034
|
readonly response: z.ZodObject<{
|
|
2810
3035
|
browserAnalyzerEnabled: z.ZodBoolean;
|
|
@@ -3317,6 +3542,56 @@ interface IndexingDiagnostics {
|
|
|
3317
3542
|
siteUrl: string;
|
|
3318
3543
|
};
|
|
3319
3544
|
}
|
|
3545
|
+
interface IndexingInspectRequest {
|
|
3546
|
+
urls: string[];
|
|
3547
|
+
}
|
|
3548
|
+
interface IndexingInspectResult {
|
|
3549
|
+
url: string;
|
|
3550
|
+
verdict: string | null;
|
|
3551
|
+
coverageState: string | null;
|
|
3552
|
+
indexingState: string | null;
|
|
3553
|
+
robotsTxtState: string | null;
|
|
3554
|
+
pageFetchState: string | null;
|
|
3555
|
+
lastCrawlTime: string | null;
|
|
3556
|
+
crawlingUserAgent: string | null;
|
|
3557
|
+
userCanonical: string | null;
|
|
3558
|
+
googleCanonical: string | null;
|
|
3559
|
+
sitemaps: string | null;
|
|
3560
|
+
referringUrls: string | null;
|
|
3561
|
+
mobileVerdict: string | null;
|
|
3562
|
+
mobileIssues: string | null;
|
|
3563
|
+
richResultsVerdict: string | null;
|
|
3564
|
+
richResultsItems: string | null;
|
|
3565
|
+
inspectionResultLink: string | null;
|
|
3566
|
+
}
|
|
3567
|
+
interface IndexingInspectRateLimit {
|
|
3568
|
+
reserved: number;
|
|
3569
|
+
remaining: number;
|
|
3570
|
+
limit: number;
|
|
3571
|
+
}
|
|
3572
|
+
interface IndexingInspectResponse {
|
|
3573
|
+
siteId: string;
|
|
3574
|
+
rateLimit: IndexingInspectRateLimit;
|
|
3575
|
+
results: IndexingInspectResult[];
|
|
3576
|
+
errors: Array<{
|
|
3577
|
+
url: string;
|
|
3578
|
+
error: string;
|
|
3579
|
+
}>;
|
|
3580
|
+
skipped: Array<{
|
|
3581
|
+
url: string;
|
|
3582
|
+
reason: string;
|
|
3583
|
+
}>;
|
|
3584
|
+
}
|
|
3585
|
+
interface IndexingInspectRateLimited {
|
|
3586
|
+
error: 'rate_limited';
|
|
3587
|
+
message: string;
|
|
3588
|
+
rateLimit: {
|
|
3589
|
+
reserved: 0;
|
|
3590
|
+
remaining: 0;
|
|
3591
|
+
limit: number;
|
|
3592
|
+
};
|
|
3593
|
+
retryAfterSeconds: number;
|
|
3594
|
+
}
|
|
3320
3595
|
interface SitemapAddedRow {
|
|
3321
3596
|
url: string;
|
|
3322
3597
|
sitemap: string;
|
|
@@ -3391,6 +3666,7 @@ interface AnalyticsClient {
|
|
|
3391
3666
|
search?: string;
|
|
3392
3667
|
}) => Promise<IndexingUrlsResponse>;
|
|
3393
3668
|
getIndexingDiagnostics: (siteId: string) => Promise<IndexingDiagnostics>;
|
|
3669
|
+
requestIndexingInspect: (siteId: string, body: IndexingInspectRequest) => Promise<IndexingInspectResponse | IndexingInspectRateLimited>;
|
|
3394
3670
|
getCountries: (siteId: string, range: {
|
|
3395
3671
|
start: string;
|
|
3396
3672
|
end: string;
|
|
@@ -3799,6 +4075,10 @@ interface GscdumpIndexingDiagnosticsResponse {
|
|
|
3799
4075
|
siteUrl: string;
|
|
3800
4076
|
};
|
|
3801
4077
|
}
|
|
4078
|
+
type GscdumpIndexingInspectRequest = IndexingInspectRequest;
|
|
4079
|
+
type GscdumpIndexingInspectResult = IndexingInspectResult;
|
|
4080
|
+
type GscdumpIndexingInspectResponse = IndexingInspectResponse;
|
|
4081
|
+
type GscdumpIndexingInspectRateLimited = IndexingInspectRateLimited;
|
|
3802
4082
|
type GscdumpAnalysisPreset = 'striking-distance' | 'opportunity' | 'decay' | 'zero-click' | 'non-brand' | 'brand-only' | 'movers-rising' | 'movers-declining';
|
|
3803
4083
|
interface GscdumpAnalysisParams {
|
|
3804
4084
|
preset: GscdumpAnalysisPreset;
|
|
@@ -4245,6 +4525,7 @@ interface PartnerClient {
|
|
|
4245
4525
|
getIndexing: (siteId: string, days?: number) => Promise<GscdumpIndexingResponse>;
|
|
4246
4526
|
getIndexingUrls: (siteId: string, params?: IndexingUrlsParams) => Promise<GscdumpIndexingUrlsResponse>;
|
|
4247
4527
|
getIndexingDiagnostics: (siteId: string) => Promise<GscdumpIndexingDiagnosticsResponse>;
|
|
4528
|
+
requestIndexingInspect: (siteId: string, body: IndexingInspectRequest) => Promise<IndexingInspectResponse | IndexingInspectRateLimited>;
|
|
4248
4529
|
getUserSettings: () => Promise<GscdumpUserSettings>;
|
|
4249
4530
|
patchUserSettings: (body: Partial<GscdumpUserSettings>) => Promise<GscdumpUserSettings>;
|
|
4250
4531
|
recoverPermission: (siteId: string) => Promise<GscdumpPermissionRecovery>;
|
|
@@ -4457,4 +4738,4 @@ declare const WEBHOOK_CONTRACT_VERSION_HEADER = "X-GSCDump-Contract-Version";
|
|
|
4457
4738
|
declare const WEBHOOK_TIMESTAMP_HEADER = "X-GSCDump-Timestamp";
|
|
4458
4739
|
declare const CANONICAL_WEBHOOK_EVENTS: readonly ["user.lifecycle.changed", "site.lifecycle.changed", "site.analytics.ready", "site.indexing.ready", "site.auth.failed", "job.failed"];
|
|
4459
4740
|
declare const VALID_WEBHOOK_EVENTS: readonly ["user.lifecycle.changed", "site.lifecycle.changed", "site.analytics.ready", "site.indexing.ready", "site.auth.failed", "job.failed"];
|
|
4460
|
-
export { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CANONICAL_WEBHOOK_EVENTS, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchAnalyticsDimension, GscSearchAnalyticsFilter, GscSearchAnalyticsFilterGroup, GscSearchAnalyticsFilterOperator, GscSearchAnalyticsRequest, GscSearchAnalyticsResponse, GscSearchAnalyticsRow, GscSearchType, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, type PartnerLifecycleAccount, type PartnerLifecycleResponse, type PartnerLifecycleSite, PartnerRealtimeEvent, PartnerRealtimeEventType, PartnerRealtimeMessage, PartnerWebhookData, PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, RealtimeAuthFailedEvent, RealtimeAuthRequiredMessage, RealtimeConnectedMessage, RealtimeEnrichmentCompleteEvent, RealtimeErrorMessage, RealtimeJobFailedEvent, RealtimeNeedsReauthEvent, RealtimePongMessage, RealtimeSiteAddedEvent, RealtimeSiteRemovedEvent, RealtimeSubscribedMessage, RealtimeSyncCompleteEvent, RealtimeSyncFailedEvent, RealtimeSyncJobCompleteEvent, RealtimeSyncProgressEvent, RealtimeSyncSiteCompleteEvent, RegisterPartnerSiteParams, RegisterPartnerUserParams, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapNextAction, SitemapRemovedRow, SitemapStatus, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WebhookEnvelope, WebhookEventType, 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, indexingIssueSchema, indexingNextActions, indexingStatuses, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, parseGrantedScopes, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };
|
|
4741
|
+
export { AccountNextAction, AccountStatus, AddPartnerTeamMemberParams, AnalysisSourcesResponse, AnalyticsClient, AnalyticsNextAction, AnalyticsStatus, BackfillRange, BackfillResponse, BindPartnerSiteTeamParams, BuilderState, BulkRegisterPartnerSiteResult, BulkRegisterPartnerSitesParams, BulkRegisterPartnerSitesResponse, CANONICAL_WEBHOOK_EVENTS, CanonicalWebhookEventType, ColumnDef, ColumnType, CountriesResponse, CountryRow, CreatePartnerTeamParams, CreateWebhookEnvelopeOptions, DataDetailOptions, DataQueryOptions, DeletePartnerUserResponse, Dimension, Filter, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_ANALYTICS_SCOPE, GscApiRange, GscComparisonFilter, GscRowQueryMeta, GscRowQueryResponse, GscSearchAnalyticsDimension, GscSearchAnalyticsFilter, GscSearchAnalyticsFilterGroup, GscSearchAnalyticsFilterOperator, GscSearchAnalyticsRequest, GscSearchAnalyticsResponse, GscSearchAnalyticsRow, GscSearchType, GscdumpAnalysisParams, GscdumpAnalysisPreset, GscdumpAnalysisResponse, GscdumpAnalysisSourcesResponse, GscdumpAvailableSite, GscdumpCanonicalMismatchRow, GscdumpCanonicalMismatchesResponse, GscdumpDataDetailResponse, GscdumpDataResponse, GscdumpDataRow, GscdumpDateRangeParams, GscdumpHealthResponse, GscdumpIndexPercentResponse, GscdumpIndexPercentSitemap, GscdumpIndexPercentTrendPoint, GscdumpIndexingDiagnosticsResponse, GscdumpIndexingInspectRateLimited, GscdumpIndexingInspectRequest, GscdumpIndexingInspectResponse, GscdumpIndexingInspectResult, GscdumpIndexingResponse, GscdumpIndexingTrendPoint, GscdumpIndexingUrl, GscdumpIndexingUrlStatus, GscdumpIndexingUrlsResponse, GscdumpInvisibleUrlRow, GscdumpKeywordSparklinesParams, GscdumpKeywordSparklinesResponse, GscdumpMeta, GscdumpOrphanPageRow, GscdumpPerSitemapHistoryEntry, GscdumpPermissionRecovery, GscdumpQueryTrendParams, GscdumpQueryTrendResponse, GscdumpSiteRegistration, GscdumpSiteReportResponse, GscdumpSitemap, GscdumpSitemapChangesResponse, GscdumpSitemapHistory, GscdumpSitemapsResponse, GscdumpSyncJobItem, GscdumpSyncJobStatus, GscdumpSyncJobsQueueCounts, GscdumpSyncJobsResponse, GscdumpSyncProgressDateStatus, GscdumpSyncProgressPhaseCounts, GscdumpSyncProgressResponse, GscdumpSyncProgressSite, GscdumpSyncStatusResponse, GscdumpTeamMemberRow, GscdumpTeamRow, GscdumpTopAssociationParams, GscdumpTopAssociationResponse, GscdumpTotals, GscdumpUserMeResponse, GscdumpUserRegistration, GscdumpUserSettings, GscdumpUserSite, GscdumpUserStatus, GscdumpUserTokenUpdate, IndexingDiagnostics, IndexingInspectRateLimit, IndexingInspectRateLimited, IndexingInspectRequest, IndexingInspectResponse, IndexingInspectResult, IndexingIssue, IndexingIssueSeverity, IndexingNextAction, IndexingStatus, IndexingUrlRow, IndexingUrlStatus, IndexingUrlsParams, IndexingUrlsResponse, InspectionHistoryRecord, InspectionHistoryResponse, InspectionIndex, LifecycleError, LifecycleErrorCode, LifecycleProgress, LifecycleWebhookEnvelope, LifecycleWebhookEvent, Metric, PartnerClient, type PartnerLifecycleAccount, type PartnerLifecycleResponse, type PartnerLifecycleSite, PartnerRealtimeEvent, PartnerRealtimeEventType, PartnerRealtimeMessage, PartnerWebhookData, PartnerWebhookHeaders, PropertyNextAction, PropertyStatus, QuerySourceMode, RealtimeAuthFailedEvent, RealtimeAuthRequiredMessage, RealtimeConnectedMessage, RealtimeEnrichmentCompleteEvent, RealtimeErrorMessage, RealtimeJobFailedEvent, RealtimeNeedsReauthEvent, RealtimePongMessage, RealtimeSiteAddedEvent, RealtimeSiteRemovedEvent, RealtimeSubscribedMessage, RealtimeSyncCompleteEvent, RealtimeSyncFailedEvent, RealtimeSyncJobCompleteEvent, RealtimeSyncProgressEvent, RealtimeSyncSiteCompleteEvent, RegisterPartnerSiteParams, RegisterPartnerUserParams, RollupEnvelope, Row, ScheduleState, SearchAppearanceResponse, SearchAppearanceRow, SiteListItem, SitemapAddedRow, SitemapChangesResponse, SitemapHistoryRecord, SitemapHistoryResponse, SitemapIndex, SitemapNextAction, SitemapRemovedRow, SitemapStatus, SourceInfoResponse, TableName, TableSchema, TenantCtx, UpdatePartnerUserTokensParams, VALID_WEBHOOK_EVENTS, WEBHOOK_CONTRACT_VERSION, WEBHOOK_CONTRACT_VERSION_HEADER, WEBHOOK_DELIVERY_HEADER, WEBHOOK_EVENT_HEADER, WEBHOOK_SIGNATURE_HEADER, WEBHOOK_TIMESTAMP_HEADER, WebhookEnvelope, WebhookEventType, 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, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, parseGrantedScopes, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };
|
package/dist/index.mjs
CHANGED
|
@@ -155,6 +155,7 @@ const partnerRoutes = {
|
|
|
155
155
|
indexing: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing`,
|
|
156
156
|
indexingUrls: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/urls`,
|
|
157
157
|
indexingDiagnostics: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/diagnostics`,
|
|
158
|
+
indexingInspect: (siteId) => `/sites/${encodeURIComponent(siteId)}/indexing/inspect`,
|
|
158
159
|
recoverPermission: (siteId) => `/sites/${encodeURIComponent(siteId)}/recover-permission`,
|
|
159
160
|
canonicalMismatches: (siteId) => `/sites/${encodeURIComponent(siteId)}/canonical-mismatches`,
|
|
160
161
|
topAssociation: (siteId) => `/sites/${encodeURIComponent(siteId)}/data/top-association`,
|
|
@@ -197,6 +198,7 @@ const analyticsRoutes = {
|
|
|
197
198
|
inspectionHistory: (siteId, hash) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/inspections/${encodeURIComponent(hash)}`,
|
|
198
199
|
indexingUrls: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/urls`,
|
|
199
200
|
indexingDiagnostics: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/diagnostics`,
|
|
201
|
+
indexingInspect: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/indexing/inspect`,
|
|
200
202
|
countries: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/countries`,
|
|
201
203
|
searchAppearance: (siteId) => `/api/__gsc/sites/${encodeURIComponent(siteId)}/search-appearance`
|
|
202
204
|
}
|
|
@@ -218,6 +220,14 @@ const CANONICAL_WEBHOOK_EVENTS = [
|
|
|
218
220
|
const VALID_WEBHOOK_EVENTS = CANONICAL_WEBHOOK_EVENTS;
|
|
219
221
|
const unknownRecord = z.record(z.string(), z.unknown());
|
|
220
222
|
const builderStateSchema = unknownRecord;
|
|
223
|
+
const searchTypeSchema = z.enum([
|
|
224
|
+
"web",
|
|
225
|
+
"image",
|
|
226
|
+
"video",
|
|
227
|
+
"news",
|
|
228
|
+
"discover",
|
|
229
|
+
"googleNews"
|
|
230
|
+
]);
|
|
221
231
|
const gscComparisonFilterSchema = z.enum([
|
|
222
232
|
"new",
|
|
223
233
|
"lost",
|
|
@@ -359,6 +369,54 @@ const indexingDiagnosticsSchema = z.object({
|
|
|
359
369
|
issues: z.array(indexingIssueSchema),
|
|
360
370
|
meta: z.object({ siteUrl: z.string() }).loose()
|
|
361
371
|
}).loose();
|
|
372
|
+
const indexingInspectRequestSchema = z.object({ urls: z.array(z.string().url()).min(1).max(10) });
|
|
373
|
+
const indexingInspectResultSchema = z.object({
|
|
374
|
+
url: z.string(),
|
|
375
|
+
verdict: z.string().nullable(),
|
|
376
|
+
coverageState: z.string().nullable(),
|
|
377
|
+
indexingState: z.string().nullable(),
|
|
378
|
+
robotsTxtState: z.string().nullable(),
|
|
379
|
+
pageFetchState: z.string().nullable(),
|
|
380
|
+
lastCrawlTime: z.string().nullable(),
|
|
381
|
+
crawlingUserAgent: z.string().nullable(),
|
|
382
|
+
userCanonical: z.string().nullable(),
|
|
383
|
+
googleCanonical: z.string().nullable(),
|
|
384
|
+
sitemaps: z.string().nullable(),
|
|
385
|
+
referringUrls: z.string().nullable(),
|
|
386
|
+
mobileVerdict: z.string().nullable(),
|
|
387
|
+
mobileIssues: z.string().nullable(),
|
|
388
|
+
richResultsVerdict: z.string().nullable(),
|
|
389
|
+
richResultsItems: z.string().nullable(),
|
|
390
|
+
inspectionResultLink: z.string().nullable()
|
|
391
|
+
}).loose();
|
|
392
|
+
const indexingInspectResponseSchema = z.object({
|
|
393
|
+
siteId: z.string(),
|
|
394
|
+
rateLimit: z.object({
|
|
395
|
+
reserved: z.number(),
|
|
396
|
+
remaining: z.number(),
|
|
397
|
+
limit: z.number()
|
|
398
|
+
}).loose(),
|
|
399
|
+
results: z.array(indexingInspectResultSchema),
|
|
400
|
+
errors: z.array(z.object({
|
|
401
|
+
url: z.string(),
|
|
402
|
+
error: z.string()
|
|
403
|
+
}).loose()),
|
|
404
|
+
skipped: z.array(z.object({
|
|
405
|
+
url: z.string(),
|
|
406
|
+
reason: z.string()
|
|
407
|
+
}).loose())
|
|
408
|
+
}).loose();
|
|
409
|
+
const indexingInspectRateLimitedSchema = z.object({
|
|
410
|
+
error: z.literal("rate_limited"),
|
|
411
|
+
message: z.string(),
|
|
412
|
+
rateLimit: z.object({
|
|
413
|
+
reserved: z.literal(0),
|
|
414
|
+
remaining: z.literal(0),
|
|
415
|
+
limit: z.number()
|
|
416
|
+
}).loose(),
|
|
417
|
+
retryAfterSeconds: z.number()
|
|
418
|
+
}).loose();
|
|
419
|
+
const indexingInspectAnyResponseSchema = z.union([indexingInspectResponseSchema, indexingInspectRateLimitedSchema]);
|
|
362
420
|
const sitemapChangesResponseSchema = z.object({
|
|
363
421
|
added: z.array(z.object({
|
|
364
422
|
url: z.string(),
|
|
@@ -1251,6 +1309,10 @@ const partnerEndpointSchemas = {
|
|
|
1251
1309
|
},
|
|
1252
1310
|
analyticsIndexingUrls: { response: indexingUrlsResponseSchema },
|
|
1253
1311
|
analyticsIndexingDiagnostics: { response: indexingDiagnosticsSchema },
|
|
1312
|
+
analyticsIndexingInspect: {
|
|
1313
|
+
body: indexingInspectRequestSchema,
|
|
1314
|
+
response: indexingInspectAnyResponseSchema
|
|
1315
|
+
},
|
|
1254
1316
|
analyticsSitemapChanges: { response: sitemapChangesResponseSchema },
|
|
1255
1317
|
analyticsAnalysisSources: { response: gscdumpAnalysisSourcesResponseSchema },
|
|
1256
1318
|
analyticsSourceInfo: { response: sourceInfoResponseSchema },
|
|
@@ -1302,6 +1364,10 @@ const partnerEndpointSchemas = {
|
|
|
1302
1364
|
response: gscdumpIndexingUrlsResponseSchema
|
|
1303
1365
|
},
|
|
1304
1366
|
getIndexingDiagnostics: { response: gscdumpIndexingDiagnosticsResponseSchema },
|
|
1367
|
+
getIndexingInspect: {
|
|
1368
|
+
body: indexingInspectRequestSchema,
|
|
1369
|
+
response: indexingInspectAnyResponseSchema
|
|
1370
|
+
},
|
|
1305
1371
|
getUserSettings: { response: gscdumpUserSettingsSchema },
|
|
1306
1372
|
patchUserSettings: {
|
|
1307
1373
|
body: gscdumpUserSettingsSchema.partial(),
|
|
@@ -1349,4 +1415,4 @@ const partnerEndpointSchemas = {
|
|
|
1349
1415
|
realtimeEvent: { message: partnerRealtimeEventSchema },
|
|
1350
1416
|
webhook: { message: partnerWebhookEnvelopeSchema }
|
|
1351
1417
|
};
|
|
1352
|
-
export { CANONICAL_WEBHOOK_EVENTS, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_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, 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, indexingIssueSchema, indexingNextActions, indexingStatuses, indexingUrlRowSchema, indexingUrlStatusSchema, indexingUrlsParamsSchema, indexingUrlsResponseSchema, inspectionHistoryRecordSchema, inspectionHistoryResponseSchema, inspectionIndexSchema, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, parseGrantedScopes, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };
|
|
1418
|
+
export { CANONICAL_WEBHOOK_EVENTS, GSCDUMP_ONBOARDING_CONTRACT_VERSION, GSCDUMP_OPTIONAL_INDEXING_SCOPE, GSCDUMP_REQUIRED_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, 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, jobFailedWebhookPayloadSchema, lifecycleErrorCodes, lifecycleErrorSchema, lifecycleProgressSchema, lifecycleWebhookEvents, parseGrantedScopes, partnerEndpointSchemas, partnerLifecycleAccountSchema, partnerLifecycleResponseSchema, partnerLifecycleSiteSchema, partnerRealtimeEventSchema, partnerRoutes, partnerWebhookDataSchema, partnerWebhookEnvelopeSchema, propertyNextActions, propertyStatuses, querySourceModes, registerPartnerSiteSchema, registerPartnerUserSchema, rollupEnvelopeSchema, searchAppearanceResponseSchema, searchAppearanceRowSchema, searchTypeSchema, siteListItemSchema, sitemapChangesResponseSchema, sitemapHistoryRecordSchema, sitemapHistoryResponseSchema, sitemapIndexSchema, sitemapNextActions, sitemapStatuses, sourceInfoResponseSchema, updatePartnerUserTokensSchema, webhookEventTypeSchema, whoamiResponseSchema };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gscdump/contracts",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.17.0",
|
|
5
5
|
"description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Harlan Wilton",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
42
|
"typescript": "^6.0.3",
|
|
43
|
-
"vitest": "^4.1.
|
|
43
|
+
"vitest": "^4.1.6"
|
|
44
44
|
},
|
|
45
45
|
"scripts": {
|
|
46
46
|
"build": "obuild",
|