@nuxtseo/protocol 0.1.0 → 0.1.1

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 (10) hide show
  1. package/dist/v1/actions.d.ts +77 -0
  2. package/dist/v1/actions.js +12 -0
  3. package/dist/v1/gsc.d.ts +120 -268
  4. package/dist/v1/gsc.js +23 -50
  5. package/dist/v1/pages.d.ts +10 -0
  6. package/dist/v1/pages.js +2 -2
  7. package/dist/v1/research.d.ts +2221 -180
  8. package/dist/v1/research.js +328 -0
  9. package/generated/openapi.v1.json +1 -1
  10. package/package.json +2 -2
package/dist/v1/actions.d.ts CHANGED
@@ -18,14 +18,23 @@ export declare const actionShowQuerySchema: z.ZodObject<{
18
18
  export declare const actionResolveBodySchema: z.ZodObject<{
19
19
  artifactVersion: z.ZodString;
20
20
  }, z.core.$strict>;
21
+ /**
22
+ * `url` is the URL the finding was observed on and stays exactly as observed —
23
+ * it is what verification re-checks. `redirectsTo` is the read-time answer to
24
+ * "does that URL still resolve there", present only when the site's own crawl
25
+ * recorded a redirect away from it. A client that follows `url` blindly edits
26
+ * the page the action named before the redirect landed.
27
+ */
21
28
  export declare const actionSubjectSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
22
29
  readonly kind: z.ZodString;
23
30
  readonly label: z.ZodString;
24
31
  readonly url: z.ZodOptional<z.ZodString>;
32
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
25
33
  }, z.core.$strip>, z.ZodObject<{
26
34
  readonly kind: z.ZodString;
27
35
  readonly label: z.ZodString;
28
36
  readonly url: z.ZodOptional<z.ZodString>;
37
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
29
38
  }, z.core.$strip>>;
30
39
  export declare const actionSourceSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
31
40
  readonly label: z.ZodString;
@@ -73,6 +82,7 @@ export declare const actionListItemSchema: import("./core.js").CompatibleRespons
73
82
  readonly kind: z.ZodString;
74
83
  readonly label: z.ZodString;
75
84
  readonly url: z.ZodOptional<z.ZodString>;
85
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
76
86
  }, z.core.$strip>>;
77
87
  readonly source: z.ZodNullable<z.ZodObject<{
78
88
  readonly label: z.ZodString;
@@ -129,6 +139,7 @@ export declare const actionListItemSchema: import("./core.js").CompatibleRespons
129
139
  readonly kind: z.ZodString;
130
140
  readonly label: z.ZodString;
131
141
  readonly url: z.ZodOptional<z.ZodString>;
142
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
132
143
  }, z.core.$strip>>;
133
144
  readonly source: z.ZodNullable<z.ZodObject<{
134
145
  readonly label: z.ZodString;
@@ -187,6 +198,7 @@ export declare const actionListDataSchema: import("./core.js").CompatibleRespons
187
198
  readonly kind: z.ZodString;
188
199
  readonly label: z.ZodString;
189
200
  readonly url: z.ZodOptional<z.ZodString>;
201
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
190
202
  }, z.core.$strip>>;
191
203
  readonly source: z.ZodNullable<z.ZodObject<{
192
204
  readonly label: z.ZodString;
@@ -252,6 +264,7 @@ export declare const actionListDataSchema: import("./core.js").CompatibleRespons
252
264
  readonly kind: z.ZodString;
253
265
  readonly label: z.ZodString;
254
266
  readonly url: z.ZodOptional<z.ZodString>;
267
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
255
268
  }, z.core.$strip>>;
256
269
  readonly source: z.ZodNullable<z.ZodObject<{
257
270
  readonly label: z.ZodString;
@@ -319,6 +332,7 @@ export declare const actionListResponseSchema: import("./core.js").CompatibleRes
319
332
  readonly kind: z.ZodString;
320
333
  readonly label: z.ZodString;
321
334
  readonly url: z.ZodOptional<z.ZodString>;
335
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
322
336
  }, z.core.$strip>>;
323
337
  readonly source: z.ZodNullable<z.ZodObject<{
324
338
  readonly label: z.ZodString;
@@ -390,6 +404,7 @@ export declare const actionListResponseSchema: import("./core.js").CompatibleRes
390
404
  readonly kind: z.ZodString;
391
405
  readonly label: z.ZodString;
392
406
  readonly url: z.ZodOptional<z.ZodString>;
407
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
393
408
  }, z.core.$strip>>;
394
409
  readonly source: z.ZodNullable<z.ZodObject<{
395
410
  readonly label: z.ZodString;
@@ -677,6 +692,12 @@ export declare const actionShowDataSchema: import("./core.js").CompatibleRespons
677
692
  readonly assessmentId: z.ZodString;
678
693
  readonly asOf: z.ZodString;
679
694
  readonly diagnosis: z.ZodString;
695
+ readonly subject: z.ZodNullable<z.ZodObject<{
696
+ readonly kind: z.ZodString;
697
+ readonly label: z.ZodString;
698
+ readonly url: z.ZodOptional<z.ZodString>;
699
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
700
+ }, z.core.$strip>>;
680
701
  readonly action: z.ZodString;
681
702
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
682
703
  _tag: z.ZodLiteral<"target-healthy">;
@@ -756,6 +777,12 @@ export declare const actionShowDataSchema: import("./core.js").CompatibleRespons
756
777
  readonly assessmentId: z.ZodString;
757
778
  readonly asOf: z.ZodString;
758
779
  readonly diagnosis: z.ZodString;
780
+ readonly subject: z.ZodNullable<z.ZodObject<{
781
+ readonly kind: z.ZodString;
782
+ readonly label: z.ZodString;
783
+ readonly url: z.ZodOptional<z.ZodString>;
784
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
785
+ }, z.core.$strip>>;
759
786
  readonly action: z.ZodString;
760
787
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
761
788
  _tag: z.ZodLiteral<"target-healthy">;
@@ -837,6 +864,12 @@ export declare const actionShowResponseSchema: import("./core.js").CompatibleRes
837
864
  readonly assessmentId: z.ZodString;
838
865
  readonly asOf: z.ZodString;
839
866
  readonly diagnosis: z.ZodString;
867
+ readonly subject: z.ZodNullable<z.ZodObject<{
868
+ readonly kind: z.ZodString;
869
+ readonly label: z.ZodString;
870
+ readonly url: z.ZodOptional<z.ZodString>;
871
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
872
+ }, z.core.$strip>>;
840
873
  readonly action: z.ZodString;
841
874
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
842
875
  _tag: z.ZodLiteral<"target-healthy">;
@@ -922,6 +955,12 @@ export declare const actionShowResponseSchema: import("./core.js").CompatibleRes
922
955
  readonly assessmentId: z.ZodString;
923
956
  readonly asOf: z.ZodString;
924
957
  readonly diagnosis: z.ZodString;
958
+ readonly subject: z.ZodNullable<z.ZodObject<{
959
+ readonly kind: z.ZodString;
960
+ readonly label: z.ZodString;
961
+ readonly url: z.ZodOptional<z.ZodString>;
962
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
963
+ }, z.core.$strip>>;
925
964
  readonly action: z.ZodString;
926
965
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
927
966
  _tag: z.ZodLiteral<"target-healthy">;
@@ -1098,6 +1137,7 @@ export declare const actionListOperation: {
1098
1137
  readonly kind: z.ZodString;
1099
1138
  readonly label: z.ZodString;
1100
1139
  readonly url: z.ZodOptional<z.ZodString>;
1140
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
1101
1141
  }, z.core.$strip>>;
1102
1142
  readonly source: z.ZodNullable<z.ZodObject<{
1103
1143
  readonly label: z.ZodString;
@@ -1169,6 +1209,7 @@ export declare const actionListOperation: {
1169
1209
  readonly kind: z.ZodString;
1170
1210
  readonly label: z.ZodString;
1171
1211
  readonly url: z.ZodOptional<z.ZodString>;
1212
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
1172
1213
  }, z.core.$strip>>;
1173
1214
  readonly source: z.ZodNullable<z.ZodObject<{
1174
1215
  readonly label: z.ZodString;
@@ -1378,6 +1419,12 @@ export declare const actionShowOperation: {
1378
1419
  readonly assessmentId: z.ZodString;
1379
1420
  readonly asOf: z.ZodString;
1380
1421
  readonly diagnosis: z.ZodString;
1422
+ readonly subject: z.ZodNullable<z.ZodObject<{
1423
+ readonly kind: z.ZodString;
1424
+ readonly label: z.ZodString;
1425
+ readonly url: z.ZodOptional<z.ZodString>;
1426
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
1427
+ }, z.core.$strip>>;
1381
1428
  readonly action: z.ZodString;
1382
1429
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
1383
1430
  _tag: z.ZodLiteral<"target-healthy">;
@@ -1463,6 +1510,12 @@ export declare const actionShowOperation: {
1463
1510
  readonly assessmentId: z.ZodString;
1464
1511
  readonly asOf: z.ZodString;
1465
1512
  readonly diagnosis: z.ZodString;
1513
+ readonly subject: z.ZodNullable<z.ZodObject<{
1514
+ readonly kind: z.ZodString;
1515
+ readonly label: z.ZodString;
1516
+ readonly url: z.ZodOptional<z.ZodString>;
1517
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
1518
+ }, z.core.$strip>>;
1466
1519
  readonly action: z.ZodString;
1467
1520
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
1468
1521
  _tag: z.ZodLiteral<"target-healthy">;
@@ -1636,6 +1689,11 @@ export declare const actionShowOperation: {
1636
1689
  readonly assessmentId: 'assessment_01JXYZ';
1637
1690
  readonly asOf: '2026-08-10T01:30:00.000Z';
1638
1691
  readonly diagnosis: 'One page returns HTTP 404.';
1692
+ readonly subject: {
1693
+ readonly kind: 'page';
1694
+ readonly label: '/pricing';
1695
+ readonly url: 'https://example.com/pricing';
1696
+ };
1639
1697
  readonly action: 'Restore or redirect the page.';
1640
1698
  readonly verifier: {
1641
1699
  readonly _tag: 'finding-cleared';
@@ -1863,6 +1921,7 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
1863
1921
  readonly kind: z.ZodString;
1864
1922
  readonly label: z.ZodString;
1865
1923
  readonly url: z.ZodOptional<z.ZodString>;
1924
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
1866
1925
  }, z.core.$strip>>;
1867
1926
  readonly source: z.ZodNullable<z.ZodObject<{
1868
1927
  readonly label: z.ZodString;
@@ -1934,6 +1993,7 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
1934
1993
  readonly kind: z.ZodString;
1935
1994
  readonly label: z.ZodString;
1936
1995
  readonly url: z.ZodOptional<z.ZodString>;
1996
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
1937
1997
  }, z.core.$strip>>;
1938
1998
  readonly source: z.ZodNullable<z.ZodObject<{
1939
1999
  readonly label: z.ZodString;
@@ -2143,6 +2203,12 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
2143
2203
  readonly assessmentId: z.ZodString;
2144
2204
  readonly asOf: z.ZodString;
2145
2205
  readonly diagnosis: z.ZodString;
2206
+ readonly subject: z.ZodNullable<z.ZodObject<{
2207
+ readonly kind: z.ZodString;
2208
+ readonly label: z.ZodString;
2209
+ readonly url: z.ZodOptional<z.ZodString>;
2210
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
2211
+ }, z.core.$strip>>;
2146
2212
  readonly action: z.ZodString;
2147
2213
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
2148
2214
  _tag: z.ZodLiteral<"target-healthy">;
@@ -2228,6 +2294,12 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
2228
2294
  readonly assessmentId: z.ZodString;
2229
2295
  readonly asOf: z.ZodString;
2230
2296
  readonly diagnosis: z.ZodString;
2297
+ readonly subject: z.ZodNullable<z.ZodObject<{
2298
+ readonly kind: z.ZodString;
2299
+ readonly label: z.ZodString;
2300
+ readonly url: z.ZodOptional<z.ZodString>;
2301
+ readonly redirectsTo: z.ZodOptional<z.ZodString>;
2302
+ }, z.core.$strip>>;
2231
2303
  readonly action: z.ZodString;
2232
2304
  readonly verifier: z.ZodDiscriminatedUnion<[z.ZodObject<{
2233
2305
  _tag: z.ZodLiteral<"target-healthy">;
@@ -2401,6 +2473,11 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
2401
2473
  readonly assessmentId: 'assessment_01JXYZ';
2402
2474
  readonly asOf: '2026-08-10T01:30:00.000Z';
2403
2475
  readonly diagnosis: 'One page returns HTTP 404.';
2476
+ readonly subject: {
2477
+ readonly kind: 'page';
2478
+ readonly label: '/pricing';
2479
+ readonly url: 'https://example.com/pricing';
2480
+ };
2404
2481
  readonly action: 'Restore or redirect the page.';
2405
2482
  readonly verifier: {
2406
2483
  readonly _tag: 'finding-cleared';
package/dist/v1/actions.js CHANGED
@@ -19,14 +19,23 @@ export const actionShowQuerySchema = schema.strictObject({
19
19
  export const actionResolveBodySchema = schema.strictObject({
20
20
  artifactVersion: schema.string().min(1),
21
21
  });
22
+ /**
23
+ * `url` is the URL the finding was observed on and stays exactly as observed —
24
+ * it is what verification re-checks. `redirectsTo` is the read-time answer to
25
+ * "does that URL still resolve there", present only when the site's own crawl
26
+ * recorded a redirect away from it. A client that follows `url` blindly edits
27
+ * the page the action named before the redirect landed.
28
+ */
22
29
  export const actionSubjectSchema = defineResponseObject({
23
30
  kind: schema.string().min(1),
24
31
  label: schema.string().min(1),
25
32
  url: schema.string().optional(),
33
+ redirectsTo: schema.string().optional(),
26
34
  }, {
27
35
  kind: schema.string().min(1),
28
36
  label: schema.string().min(1),
29
37
  url: schema.string().optional(),
38
+ redirectsTo: schema.string().optional(),
30
39
  });
31
40
  export const actionSourceSchema = defineResponseObject({ label: schema.string().min(1), url: schema.string().url() }, { label: schema.string().min(1), url: schema.string().url() });
32
41
  export const actionEvidenceSummarySchema = defineResponseObject({
@@ -246,6 +255,7 @@ export const actionShowDataSchema = defineResponseObject({
246
255
  assessmentId: schema.string().min(1),
247
256
  asOf: schema.string().datetime(),
248
257
  diagnosis: schema.string().min(1),
258
+ subject: actionSubjectSchema.producer.nullable(),
249
259
  action: schema.string().min(1),
250
260
  verifier: actionVerifierSchema,
251
261
  materiality: schema.strictObject({
@@ -261,6 +271,7 @@ export const actionShowDataSchema = defineResponseObject({
261
271
  assessmentId: schema.string().min(1),
262
272
  asOf: schema.string().datetime(),
263
273
  diagnosis: schema.string().min(1),
274
+ subject: actionSubjectSchema.client.nullable(),
264
275
  action: schema.string().min(1),
265
276
  verifier: actionVerifierClientSchema,
266
277
  materiality: schema.looseObject({
@@ -381,6 +392,7 @@ export const actionShowOperation = defineOperation({
381
392
  assessmentId: 'assessment_01JXYZ',
382
393
  asOf: '2026-08-10T01:30:00.000Z',
383
394
  diagnosis: 'One page returns HTTP 404.',
395
+ subject: { kind: 'page', label: '/pricing', url: 'https://example.com/pricing' },
384
396
  action: 'Restore or redirect the page.',
385
397
  verifier: { _tag: 'finding-cleared', findingType: 'broken-pages' },
386
398
  materiality: { affectedSubjects: 1, internalReferrers: 2 },