@gscdump/contracts 7.2.0 → 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.
Files changed (16) hide show
  1. package/dist/analytics.d.mts +2 -2
  2. package/dist/endpoints.d.mts +10 -4
  3. package/dist/index.d.mts +3 -3
  4. package/dist/index.mjs +2 -2
  5. package/dist/indexing-coverage.d.mts +18 -18
  6. package/dist/partner.d.mts +2 -2
  7. package/dist/schemas.d.mts +50 -13
  8. package/dist/schemas.mjs +20 -5
  9. package/dist/types.d.mts +12 -2
  10. package/dist/v1/bing-sites.d.mts +14 -14
  11. package/dist/v1/google-indexing.d.mts +1 -1
  12. package/dist/v1/operations.d.mts +102 -90
  13. package/dist/v1/operations.mjs +12 -7
  14. package/dist/v1/sitemap-evidence.d.mts +9 -9
  15. package/dist/v1/sitemap-submission.d.mts +10 -10
  16. package/package.json +1 -1
package/dist/v1/operations.mjs CHANGED
@@ -1,6 +1,6 @@
1
1
  import { siteHoldReasonSchema } from "../entitlements.mjs";
2
2
  import { watchedUrlsChangeRequestSchema, watchedUrlsChangeResponseSchema, watchedUrlsResponseSchema } from "../indexing-coverage.mjs";
3
- import { addPartnerTeamMemberSchema, bindPartnerSiteTeamSchema, bindPartnerTeamCatalogResponseSchema, bindPartnerTeamCatalogSchema, builderStateSchema, createPartnerTeamSchema, gscComparisonFilterSchema, gscComparisonOrderBySchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingTransitionFieldSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpPageTrendResponseSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapExportQuerySchema, gscdumpSitemapExportResponseSchema, gscdumpSitemapMembershipParamsSchema, gscdumpSitemapMembershipResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, gscdumpSitemapsResponseSchema, gscdumpTeamRoleSchema, gscdumpTopAssociationResponseSchema, gscdumpUserRegistrationSchema, indexingUrlsResponseSchema, partnerSiteTeamBindingResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, partnerTeamCreatedResponseSchema, partnerTeamDeletedResponseSchema, partnerTeamMemberAddedResponseSchema, partnerTeamMemberRemovedResponseSchema, partnerTeamMemberRoleResponseSchema, partnerTeamMembersResponseSchema, partnerTeamRenamedResponseSchema, registerPartnerSiteSchema, registerPartnerUserSchema, renamePartnerTeamSchema, searchTypeSchema, siteIntIdCrosswalkResponseSchema, sitemapChangesTruncationReasonSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema } from "../schemas.mjs";
3
+ import { addPartnerTeamMemberSchema, bindPartnerSiteTeamSchema, bindPartnerTeamCatalogResponseSchema, bindPartnerTeamCatalogSchema, builderStateSchema, createPartnerTeamSchema, gscComparisonFilterSchema, gscComparisonOrderBySchema, gscdumpAnalysisBundleResponseSchema, gscdumpAnalysisPresetSchema, gscdumpAnalysisResponseSchema, gscdumpAvailableSiteSchema, gscdumpCanonicalMismatchesResponseSchema, gscdumpDataDetailResponseSchema, gscdumpDataResponseSchema, gscdumpDeletePartnerUserResponseSchema, gscdumpIndexPercentResponseSchema, gscdumpIndexingDiagnosticsResponseSchema, gscdumpIndexingResponseSchema, gscdumpIndexingTransitionFieldSchema, gscdumpKeywordSparklinesResponseSchema, gscdumpPageTrendResponseSchema, gscdumpQueryTrendResponseSchema, gscdumpSiteRegistrationSchema, gscdumpSitemapChangesResponseSchema, gscdumpSitemapExportQuerySchema, gscdumpSitemapExportResponseSchema, gscdumpSitemapMembershipParamsSchema, gscdumpSitemapMembershipResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, gscdumpSitemapsResponseSchema, gscdumpTeamRoleSchema, gscdumpTopAssociationResponseSchema, gscdumpUserRegistrationSchema, indexingSitemapFilterShape, indexingUrlsResponseSchema, partnerSiteTeamBindingResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, partnerTeamCreatedResponseSchema, partnerTeamDeletedResponseSchema, partnerTeamMemberAddedResponseSchema, partnerTeamMemberRemovedResponseSchema, partnerTeamMemberRoleResponseSchema, partnerTeamMembersResponseSchema, partnerTeamRenamedResponseSchema, refineIndexingSitemapFilter, registerPartnerSiteSchema, registerPartnerUserSchema, renamePartnerTeamSchema, searchTypeSchema, siteIntIdCrosswalkResponseSchema, sitemapChangesTruncationReasonSchema, teamCatalogRefSchema, updatePartnerUserTokensSchema } from "../schemas.mjs";
4
4
  import { siteVersionBeginRequestSchema, siteVersionCandidateRequestSchema, siteVersionCandidateSchema, siteVersionIdentityResponseSchema, siteVersionPreviewRequestSchema, siteVersionPreviewSchema } from "../site-version.mjs";
5
5
  import "./version.mjs";
6
6
  import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.mjs";
@@ -104,7 +104,10 @@ function createGscdumpV1Protocol() {
104
104
  const integerQuery = (number, wirePattern) => z.union([number, z.string().regex(wirePattern)]);
105
105
  const numericQuery = z.union([z.number(), z.string().regex(/^-?(?:\d+(?:\.\d+)?|\.\d+)$/)]);
106
106
  const calendarDate = z.string().regex(/^\d{4}-\d{2}-\d{2}$/, "expected YYYY-MM-DD");
107
- const indexingSummaryQuery = z.strictObject({ days: integerQuery(z.number().int().min(1).max(90), /^(?:[1-9]|[1-8]\d|90)$/).optional() });
107
+ const indexingSummaryQuery = z.strictObject({
108
+ days: integerQuery(z.number().int().min(1).max(90), /^(?:[1-9]|[1-8]\d|90)$/).optional(),
109
+ ...indexingSitemapFilterShape
110
+ }).superRefine(refineIndexingSitemapFilter);
108
111
  const indexingUrlsQuery = z.strictObject({
109
112
  limit: integerQuery(z.number().int().min(1).max(500), /^(?:[1-9]|[1-9]\d|[1-4]\d{2}|500)$/).optional(),
110
113
  offset: integerQuery(z.number().int().min(0), /^(?:0|[1-9]\d*)$/).optional(),
@@ -120,8 +123,9 @@ function createGscdumpV1Protocol() {
120
123
  z.literal(false),
121
124
  z.literal("0"),
122
125
  z.literal("false")
123
- ]).optional()
124
- });
126
+ ]).optional(),
127
+ ...indexingSitemapFilterShape
128
+ }).superRefine(refineIndexingSitemapFilter);
125
129
  const bingIndexingEvidenceQuery = z.strictObject({
126
130
  limit: integerQuery(z.number().int().min(1).max(500), /^(?:[1-9]|[1-9]\d|[1-4]\d{2}|500)$/).optional(),
127
131
  offset: integerQuery(z.number().int().min(0), /^(?:0|[1-9]\d*)$/).optional()
@@ -148,8 +152,9 @@ function createGscdumpV1Protocol() {
148
152
  });
149
153
  const indexingDiagnosticsQuery = z.strictObject({
150
154
  sampleIssues: z.union([z.string(), z.array(z.string())]).optional(),
151
- sampleLimit: integerQuery(z.number().int().min(1).max(25), /^(?:[1-9]|1\d|2[0-5])$/).optional()
152
- });
155
+ sampleLimit: integerQuery(z.number().int().min(1).max(25), /^(?:[1-9]|1\d|2[0-5])$/).optional(),
156
+ ...indexingSitemapFilterShape
157
+ }).superRefine(refineIndexingSitemapFilter);
153
158
  const sitemapChangesQuery = z.strictObject({ days: integerQuery(z.number().int().min(1).max(90), /^(?:[1-9]|[1-8]\d|90)$/).optional() });
154
159
  const analysisBaseQueryShape = {
155
160
  startDate: z.string().min(1),
@@ -1385,7 +1390,7 @@ function createGscdumpV1Protocol() {
1385
1390
  lifecycle: { introduced: "1.0.0" },
1386
1391
  docs: {
1387
1392
  summary: "Get site indexing summary",
1388
- description: "Returns indexing coverage, trend, and inspection signal totals.",
1393
+ description: "Returns indexing coverage, trend, and inspection signal totals. A Sitemap filter returns no trend or changes.",
1389
1394
  tags: ["Indexing"],
1390
1395
  examples: {
1391
1396
  request: {
package/dist/v1/sitemap-evidence.d.mts CHANGED
@@ -1,8 +1,8 @@
1
1
  import { z } from "zod";
2
2
  export declare const sitemapInspectQueryV1Schema: z.ZodObject<{
3
3
  searchEngine: z.ZodEnum<{
4
- bing: "bing";
5
4
  google: "google";
5
+ bing: "bing";
6
6
  }>;
7
7
  url: z.ZodURL;
8
8
  }, z.core.$strict>;
@@ -52,8 +52,8 @@ export declare const sitemapEvidenceV1Schemas: {
52
52
  }, z.core.$strip>], "_tag">;
53
53
  }, z.core.$strip>, z.ZodObject<{
54
54
  readonly searchEngine: z.ZodEnum<{
55
- bing: "bing";
56
55
  google: "google";
56
+ bing: "bing";
57
57
  }>;
58
58
  readonly sitemapUrl: z.ZodURL;
59
59
  readonly capture: z.ZodObject<{
@@ -62,14 +62,14 @@ export declare const sitemapEvidenceV1Schemas: {
62
62
  readonly state: z.ZodObject<{
63
63
  readonly _tag: z.ZodLiteral<"unavailable">;
64
64
  readonly reason: z.ZodEnum<{
65
- "reauthorization-required": "reauthorization-required";
65
+ "not-checked": "not-checked";
66
66
  "permission-lost": "permission-lost";
67
67
  "grant-missing": "grant-missing";
68
+ "provider-unavailable": "provider-unavailable";
69
+ "reauthorization-required": "reauthorization-required";
68
70
  "not-enabled": "not-enabled";
69
71
  "site-unverified": "site-unverified";
70
72
  throttled: "throttled";
71
- "provider-unavailable": "provider-unavailable";
72
- "not-checked": "not-checked";
73
73
  }>;
74
74
  readonly retryable: z.ZodBoolean;
75
75
  }, z.core.$strip>;
@@ -118,8 +118,8 @@ export declare const sitemapEvidenceV1Schemas: {
118
118
  }, z.core.$strip>], "_tag">;
119
119
  }, z.core.$strip>, z.ZodObject<{
120
120
  readonly searchEngine: z.ZodEnum<{
121
- bing: "bing";
122
121
  google: "google";
122
+ bing: "bing";
123
123
  }>;
124
124
  readonly sitemapUrl: z.ZodURL;
125
125
  readonly capture: z.ZodObject<{
@@ -128,14 +128,14 @@ export declare const sitemapEvidenceV1Schemas: {
128
128
  readonly state: z.ZodObject<{
129
129
  readonly _tag: z.ZodLiteral<"unavailable">;
130
130
  readonly reason: z.ZodEnum<{
131
- "reauthorization-required": "reauthorization-required";
131
+ "not-checked": "not-checked";
132
132
  "permission-lost": "permission-lost";
133
133
  "grant-missing": "grant-missing";
134
+ "provider-unavailable": "provider-unavailable";
135
+ "reauthorization-required": "reauthorization-required";
134
136
  "not-enabled": "not-enabled";
135
137
  "site-unverified": "site-unverified";
136
138
  throttled: "throttled";
137
- "provider-unavailable": "provider-unavailable";
138
- "not-checked": "not-checked";
139
139
  }>;
140
140
  readonly retryable: z.ZodBoolean;
141
141
  }, z.core.$strip>;
package/dist/v1/sitemap-submission.d.mts CHANGED
@@ -263,14 +263,14 @@ export declare const sitemapSubmitResultV1Schemas: {
263
263
  }, z.core.$strip>, z.ZodObject<{
264
264
  readonly _tag: z.ZodLiteral<"failed">;
265
265
  readonly reason: z.ZodEnum<{
266
- "permission-lost": "permission-lost";
267
- "grant-missing": "grant-missing";
268
- "no-sitemap-found": "no-sitemap-found";
269
- "provider-unavailable": "provider-unavailable";
270
- rejected: "rejected";
271
266
  "needs-write-access": "needs-write-access";
272
267
  "insufficient-permission": "insufficient-permission";
268
+ "no-sitemap-found": "no-sitemap-found";
269
+ "permission-lost": "permission-lost";
270
+ "grant-missing": "grant-missing";
273
271
  "already-listed": "already-listed";
272
+ rejected: "rejected";
273
+ "provider-unavailable": "provider-unavailable";
274
274
  }>;
275
275
  readonly retryable: z.ZodBoolean;
276
276
  readonly sitemapUrl: z.ZodNullable<z.ZodURL>;
@@ -282,14 +282,14 @@ export declare const sitemapSubmitResultV1Schemas: {
282
282
  }, z.core.$strip>, z.ZodObject<{
283
283
  readonly _tag: z.ZodLiteral<"failed">;
284
284
  readonly reason: z.ZodEnum<{
285
- "permission-lost": "permission-lost";
286
- "grant-missing": "grant-missing";
287
- "no-sitemap-found": "no-sitemap-found";
288
- "provider-unavailable": "provider-unavailable";
289
- rejected: "rejected";
290
285
  "needs-write-access": "needs-write-access";
291
286
  "insufficient-permission": "insufficient-permission";
287
+ "no-sitemap-found": "no-sitemap-found";
288
+ "permission-lost": "permission-lost";
289
+ "grant-missing": "grant-missing";
292
290
  "already-listed": "already-listed";
291
+ rejected: "rejected";
292
+ "provider-unavailable": "provider-unavailable";
293
293
  }>;
294
294
  readonly retryable: z.ZodBoolean;
295
295
  readonly sitemapUrl: z.ZodNullable<z.ZodURL>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@gscdump/contracts",
3
3
  "type": "module",
4
- "version": "7.2.0",
4
+ "version": "7.3.0",
5
5
  "description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
6
6
  "author": {
7
7
  "name": "Harlan Wilton",