@gscdump/contracts 7.1.1 → 7.3.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/types.d.mts CHANGED
@@ -217,7 +217,17 @@ export interface IndexingDiagnostics {
217
217
  rollupBuiltAt?: number;
218
218
  };
219
219
  }
220
- export interface IndexingDiagnosticsParams {
220
+ /**
221
+ * The Sitemap filter on the indexing summary, URL and diagnostics reads. Send
222
+ * one key at most. `feedpath` counts only URLs that the named Sitemaps list.
223
+ * `excludeFeedpath` counts only URLs that some other live Sitemap lists. Each
224
+ * value is a Sitemap URL or a path on the Site's host.
225
+ */
226
+ export interface IndexingSitemapFilterParams {
227
+ feedpath?: string | string[];
228
+ excludeFeedpath?: string | string[];
229
+ }
230
+ export interface IndexingDiagnosticsParams extends IndexingSitemapFilterParams {
221
231
  sampleIssues?: string[] | string;
222
232
  sampleLimit?: number;
223
233
  }
@@ -1068,7 +1078,7 @@ export interface DataDetailOptions {
1068
1078
  comparison?: BuilderStateWire;
1069
1079
  searchType?: GscSearchType;
1070
1080
  }
1071
- export interface IndexingUrlsParams {
1081
+ export interface IndexingUrlsParams extends IndexingSitemapFilterParams {
1072
1082
  limit?: number;
1073
1083
  offset?: number;
1074
1084
  status?: GscdumpIndexingUrlStatus;
@@ -101,8 +101,8 @@ export declare const bingSiteStateV1Schemas: {
101
101
  }, z.core.$strip>, z.ZodObject<{
102
102
  readonly _tag: z.ZodLiteral<"grant-required">;
103
103
  readonly reason: z.ZodEnum<{
104
- "reauthorization-required": "reauthorization-required";
105
104
  "grant-missing": "grant-missing";
105
+ "reauthorization-required": "reauthorization-required";
106
106
  }>;
107
107
  }, z.core.$strip>, z.ZodObject<{
108
108
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -159,8 +159,8 @@ export declare const bingSiteStateV1Schemas: {
159
159
  }, z.core.$strip>, z.ZodObject<{
160
160
  readonly _tag: z.ZodLiteral<"grant-required">;
161
161
  readonly reason: z.ZodEnum<{
162
- "reauthorization-required": "reauthorization-required";
163
162
  "grant-missing": "grant-missing";
163
+ "reauthorization-required": "reauthorization-required";
164
164
  }>;
165
165
  }, z.core.$strip>, z.ZodObject<{
166
166
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -228,8 +228,8 @@ export declare const bingSiteV1Schemas: CompatibleResponseSchema<z.ZodObject<{
228
228
  }, z.core.$strip>, z.ZodObject<{
229
229
  readonly _tag: z.ZodLiteral<"grant-required">;
230
230
  readonly reason: z.ZodEnum<{
231
- "reauthorization-required": "reauthorization-required";
232
231
  "grant-missing": "grant-missing";
232
+ "reauthorization-required": "reauthorization-required";
233
233
  }>;
234
234
  }, z.core.$strip>, z.ZodObject<{
235
235
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -291,8 +291,8 @@ export declare const bingSiteV1Schemas: CompatibleResponseSchema<z.ZodObject<{
291
291
  }, z.core.$strip>, z.ZodObject<{
292
292
  readonly _tag: z.ZodLiteral<"grant-required">;
293
293
  readonly reason: z.ZodEnum<{
294
- "reauthorization-required": "reauthorization-required";
295
294
  "grant-missing": "grant-missing";
295
+ "reauthorization-required": "reauthorization-required";
296
296
  }>;
297
297
  }, z.core.$strip>, z.ZodObject<{
298
298
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -384,8 +384,8 @@ export declare const bingSitesV1Schemas: CompatibleResponseSchema<z.ZodObject<{
384
384
  }, z.core.$strip>, z.ZodObject<{
385
385
  readonly _tag: z.ZodLiteral<"grant-required">;
386
386
  readonly reason: z.ZodEnum<{
387
- "reauthorization-required": "reauthorization-required";
388
387
  "grant-missing": "grant-missing";
388
+ "reauthorization-required": "reauthorization-required";
389
389
  }>;
390
390
  }, z.core.$strip>, z.ZodObject<{
391
391
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -458,8 +458,8 @@ export declare const bingSitesV1Schemas: CompatibleResponseSchema<z.ZodObject<{
458
458
  }, z.core.$strip>, z.ZodObject<{
459
459
  readonly _tag: z.ZodLiteral<"grant-required">;
460
460
  readonly reason: z.ZodEnum<{
461
- "reauthorization-required": "reauthorization-required";
462
461
  "grant-missing": "grant-missing";
462
+ "reauthorization-required": "reauthorization-required";
463
463
  }>;
464
464
  }, z.core.$strip>, z.ZodObject<{
465
465
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -526,8 +526,8 @@ export declare const bingLinkResultV1Schemas: {
526
526
  }, z.core.$strip>, z.ZodObject<{
527
527
  readonly _tag: z.ZodLiteral<"grant-required">;
528
528
  readonly reason: z.ZodEnum<{
529
- "reauthorization-required": "reauthorization-required";
530
529
  "grant-missing": "grant-missing";
530
+ "reauthorization-required": "reauthorization-required";
531
531
  }>;
532
532
  }, z.core.$strip>, z.ZodObject<{
533
533
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -542,8 +542,8 @@ export declare const bingLinkResultV1Schemas: {
542
542
  }, z.core.$strip>, z.ZodObject<{
543
543
  readonly _tag: z.ZodLiteral<"grant-required">;
544
544
  readonly reason: z.ZodEnum<{
545
- "reauthorization-required": "reauthorization-required";
546
545
  "grant-missing": "grant-missing";
546
+ "reauthorization-required": "reauthorization-required";
547
547
  }>;
548
548
  }, z.core.$strip>, z.ZodObject<{
549
549
  readonly _tag: z.ZodLiteral<"failed">;
@@ -608,8 +608,8 @@ export declare const bingLinkResultV1Schemas: {
608
608
  }, z.core.$strip>, z.ZodObject<{
609
609
  readonly _tag: z.ZodLiteral<"grant-required">;
610
610
  readonly reason: z.ZodEnum<{
611
- "reauthorization-required": "reauthorization-required";
612
611
  "grant-missing": "grant-missing";
612
+ "reauthorization-required": "reauthorization-required";
613
613
  }>;
614
614
  }, z.core.$strip>, z.ZodObject<{
615
615
  readonly _tag: z.ZodLiteral<"reauthorization-required">;
@@ -624,8 +624,8 @@ export declare const bingLinkResultV1Schemas: {
624
624
  }, z.core.$strip>, z.ZodObject<{
625
625
  readonly _tag: z.ZodLiteral<"grant-required">;
626
626
  readonly reason: z.ZodEnum<{
627
- "reauthorization-required": "reauthorization-required";
628
627
  "grant-missing": "grant-missing";
628
+ "reauthorization-required": "reauthorization-required";
629
629
  }>;
630
630
  }, z.core.$strip>, z.ZodObject<{
631
631
  readonly _tag: z.ZodLiteral<"failed">;
@@ -690,11 +690,11 @@ export declare const bingSitemapSubmitResultV1Schemas: {
690
690
  }, z.core.$strip>, z.ZodObject<{
691
691
  readonly _tag: z.ZodLiteral<"failed">;
692
692
  readonly reason: z.ZodEnum<{
693
+ "no-sitemap-found": "no-sitemap-found";
694
+ "provider-unavailable": "provider-unavailable";
693
695
  "grant-required": "grant-required";
694
696
  "site-unverified": "site-unverified";
695
- "no-sitemap-found": "no-sitemap-found";
696
697
  throttled: "throttled";
697
- "provider-unavailable": "provider-unavailable";
698
698
  }>;
699
699
  readonly retryable: z.ZodBoolean;
700
700
  }, z.core.$strip>], "_tag">;
@@ -728,11 +728,11 @@ export declare const bingSitemapSubmitResultV1Schemas: {
728
728
  }, z.core.$strip>, z.ZodObject<{
729
729
  readonly _tag: z.ZodLiteral<"failed">;
730
730
  readonly reason: z.ZodEnum<{
731
+ "no-sitemap-found": "no-sitemap-found";
732
+ "provider-unavailable": "provider-unavailable";
731
733
  "grant-required": "grant-required";
732
734
  "site-unverified": "site-unverified";
733
- "no-sitemap-found": "no-sitemap-found";
734
735
  throttled: "throttled";
735
- "provider-unavailable": "provider-unavailable";
736
736
  }>;
737
737
  readonly retryable: z.ZodBoolean;
738
738
  }, z.core.$strip>], "_tag">;
@@ -232,8 +232,8 @@ export declare const googleSubmissionRefusalSchema: z.ZodDiscriminatedUnion<[z.Z
232
232
  }, z.core.$strip>, z.ZodObject<{
233
233
  reason: z.ZodLiteral<"needs_indexing_api_grant">;
234
234
  grant: z.ZodEnum<{
235
- "reauthorization-required": "reauthorization-required";
236
235
  missing: "missing";
236
+ "reauthorization-required": "reauthorization-required";
237
237
  }>;
238
238
  }, z.core.$strip>, z.ZodObject<{
239
239
  reason: z.ZodLiteral<"url_outside_site">;