@nuxtseo/protocol 0.1.0 → 0.1.2

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 (12) hide show
  1. package/dist/v1/account.d.ts +2 -62
  2. package/dist/v1/account.js +2 -2
  3. package/dist/v1/actions.d.ts +331 -0
  4. package/dist/v1/actions.js +28 -0
  5. package/dist/v1/gsc.d.ts +120 -268
  6. package/dist/v1/gsc.js +23 -50
  7. package/dist/v1/pages.d.ts +64 -0
  8. package/dist/v1/pages.js +13 -2
  9. package/dist/v1/research.d.ts +2221 -180
  10. package/dist/v1/research.js +328 -0
  11. package/generated/openapi.v1.json +1 -1
  12. package/package.json +2 -2
package/dist/v1/pages.d.ts CHANGED
@@ -33,6 +33,7 @@ export declare const pageObservationSchema: import("./core.js").CompatibleRespon
33
33
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
34
34
  readonly resolution: z.ZodNullable<z.ZodEnum<{
35
35
  excluded: "excluded";
36
+ expired: "expired";
36
37
  fixed: "fixed";
37
38
  removed: "removed";
38
39
  unmonitored: "unmonitored";
@@ -54,6 +55,7 @@ export declare const pageObservationSchema: import("./core.js").CompatibleRespon
54
55
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
55
56
  readonly resolution: z.ZodNullable<z.ZodEnum<{
56
57
  excluded: "excluded";
58
+ expired: "expired";
57
59
  fixed: "fixed";
58
60
  removed: "removed";
59
61
  unmonitored: "unmonitored";
@@ -99,6 +101,18 @@ export declare const pageRankingKeywordSchema: import("./core.js").CompatibleRes
99
101
  readonly position: z.ZodNullable<z.ZodNumber>;
100
102
  readonly checkedAt: z.ZodNullable<z.ZodString>;
101
103
  }, z.core.$strip>>;
104
+ /**
105
+ * Whether the empty parts of this payload mean "clean" or "not looked at".
106
+ * `issues-open`: unresolved observations exist. `scanned-clear`: observation
107
+ * sources recorded this Page before and every observation is resolved.
108
+ * `never-scanned`: no observation source has ever recorded this Page, so zero
109
+ * rows and a null Lighthouse are absence of evidence, not a clean bill.
110
+ */
111
+ export declare const pageObservationCoverageSchema: z.ZodEnum<{
112
+ "issues-open": "issues-open";
113
+ "never-scanned": "never-scanned";
114
+ "scanned-clear": "scanned-clear";
115
+ }>;
102
116
  export declare const pageInspectDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
103
117
  readonly page: z.ZodObject<{
104
118
  url: z.ZodString;
@@ -122,12 +136,18 @@ export declare const pageInspectDataSchema: import("./core.js").CompatibleRespon
122
136
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
123
137
  readonly resolution: z.ZodNullable<z.ZodEnum<{
124
138
  excluded: "excluded";
139
+ expired: "expired";
125
140
  fixed: "fixed";
126
141
  removed: "removed";
127
142
  unmonitored: "unmonitored";
128
143
  }>>;
129
144
  }, z.core.$strip>>;
130
145
  total: z.ZodNumber;
146
+ coverage: z.ZodEnum<{
147
+ "issues-open": "issues-open";
148
+ "never-scanned": "never-scanned";
149
+ "scanned-clear": "scanned-clear";
150
+ }>;
131
151
  pagination: z.ZodObject<{
132
152
  limit: z.ZodNumber;
133
153
  offset: z.ZodNumber;
@@ -182,12 +202,18 @@ export declare const pageInspectDataSchema: import("./core.js").CompatibleRespon
182
202
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
183
203
  readonly resolution: z.ZodNullable<z.ZodEnum<{
184
204
  excluded: "excluded";
205
+ expired: "expired";
185
206
  fixed: "fixed";
186
207
  removed: "removed";
187
208
  unmonitored: "unmonitored";
188
209
  }>>;
189
210
  }, z.core.$strip>>;
190
211
  total: z.ZodNumber;
212
+ coverage: z.ZodEnum<{
213
+ "issues-open": "issues-open";
214
+ "never-scanned": "never-scanned";
215
+ "scanned-clear": "scanned-clear";
216
+ }>;
191
217
  pagination: z.ZodObject<{
192
218
  limit: z.ZodNumber;
193
219
  offset: z.ZodNumber;
@@ -244,12 +270,18 @@ export declare const pageInspectResponseSchema: import("./core.js").CompatibleRe
244
270
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
245
271
  readonly resolution: z.ZodNullable<z.ZodEnum<{
246
272
  excluded: "excluded";
273
+ expired: "expired";
247
274
  fixed: "fixed";
248
275
  removed: "removed";
249
276
  unmonitored: "unmonitored";
250
277
  }>>;
251
278
  }, z.core.$strip>>;
252
279
  total: z.ZodNumber;
280
+ coverage: z.ZodEnum<{
281
+ "issues-open": "issues-open";
282
+ "never-scanned": "never-scanned";
283
+ "scanned-clear": "scanned-clear";
284
+ }>;
253
285
  pagination: z.ZodObject<{
254
286
  limit: z.ZodNumber;
255
287
  offset: z.ZodNumber;
@@ -310,12 +342,18 @@ export declare const pageInspectResponseSchema: import("./core.js").CompatibleRe
310
342
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
311
343
  readonly resolution: z.ZodNullable<z.ZodEnum<{
312
344
  excluded: "excluded";
345
+ expired: "expired";
313
346
  fixed: "fixed";
314
347
  removed: "removed";
315
348
  unmonitored: "unmonitored";
316
349
  }>>;
317
350
  }, z.core.$strip>>;
318
351
  total: z.ZodNumber;
352
+ coverage: z.ZodEnum<{
353
+ "issues-open": "issues-open";
354
+ "never-scanned": "never-scanned";
355
+ "scanned-clear": "scanned-clear";
356
+ }>;
319
357
  pagination: z.ZodObject<{
320
358
  limit: z.ZodNumber;
321
359
  offset: z.ZodNumber;
@@ -504,12 +542,18 @@ export declare const pageInspectOperation: {
504
542
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
505
543
  readonly resolution: z.ZodNullable<z.ZodEnum<{
506
544
  excluded: "excluded";
545
+ expired: "expired";
507
546
  fixed: "fixed";
508
547
  removed: "removed";
509
548
  unmonitored: "unmonitored";
510
549
  }>>;
511
550
  }, z.core.$strip>>;
512
551
  total: z.ZodNumber;
552
+ coverage: z.ZodEnum<{
553
+ "issues-open": "issues-open";
554
+ "never-scanned": "never-scanned";
555
+ "scanned-clear": "scanned-clear";
556
+ }>;
513
557
  pagination: z.ZodObject<{
514
558
  limit: z.ZodNumber;
515
559
  offset: z.ZodNumber;
@@ -570,12 +614,18 @@ export declare const pageInspectOperation: {
570
614
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
571
615
  readonly resolution: z.ZodNullable<z.ZodEnum<{
572
616
  excluded: "excluded";
617
+ expired: "expired";
573
618
  fixed: "fixed";
574
619
  removed: "removed";
575
620
  unmonitored: "unmonitored";
576
621
  }>>;
577
622
  }, z.core.$strip>>;
578
623
  total: z.ZodNumber;
624
+ coverage: z.ZodEnum<{
625
+ "issues-open": "issues-open";
626
+ "never-scanned": "never-scanned";
627
+ "scanned-clear": "scanned-clear";
628
+ }>;
579
629
  pagination: z.ZodObject<{
580
630
  limit: z.ZodNumber;
581
631
  offset: z.ZodNumber;
@@ -711,6 +761,7 @@ export declare const pageInspectOperation: {
711
761
  readonly observations: {
712
762
  readonly rows: readonly [];
713
763
  readonly total: 0;
764
+ readonly coverage: 'never-scanned';
714
765
  readonly pagination: {
715
766
  readonly limit: 100;
716
767
  readonly offset: 0;
@@ -983,12 +1034,18 @@ export declare const pagesV1Registry: import("./core.js").PublicV1Registry<{
983
1034
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
984
1035
  readonly resolution: z.ZodNullable<z.ZodEnum<{
985
1036
  excluded: "excluded";
1037
+ expired: "expired";
986
1038
  fixed: "fixed";
987
1039
  removed: "removed";
988
1040
  unmonitored: "unmonitored";
989
1041
  }>>;
990
1042
  }, z.core.$strip>>;
991
1043
  total: z.ZodNumber;
1044
+ coverage: z.ZodEnum<{
1045
+ "issues-open": "issues-open";
1046
+ "never-scanned": "never-scanned";
1047
+ "scanned-clear": "scanned-clear";
1048
+ }>;
992
1049
  pagination: z.ZodObject<{
993
1050
  limit: z.ZodNumber;
994
1051
  offset: z.ZodNumber;
@@ -1049,12 +1106,18 @@ export declare const pagesV1Registry: import("./core.js").PublicV1Registry<{
1049
1106
  readonly resolvedAt: z.ZodNullable<z.ZodString>;
1050
1107
  readonly resolution: z.ZodNullable<z.ZodEnum<{
1051
1108
  excluded: "excluded";
1109
+ expired: "expired";
1052
1110
  fixed: "fixed";
1053
1111
  removed: "removed";
1054
1112
  unmonitored: "unmonitored";
1055
1113
  }>>;
1056
1114
  }, z.core.$strip>>;
1057
1115
  total: z.ZodNumber;
1116
+ coverage: z.ZodEnum<{
1117
+ "issues-open": "issues-open";
1118
+ "never-scanned": "never-scanned";
1119
+ "scanned-clear": "scanned-clear";
1120
+ }>;
1058
1121
  pagination: z.ZodObject<{
1059
1122
  limit: z.ZodNumber;
1060
1123
  offset: z.ZodNumber;
@@ -1190,6 +1253,7 @@ export declare const pagesV1Registry: import("./core.js").PublicV1Registry<{
1190
1253
  readonly observations: {
1191
1254
  readonly rows: readonly [];
1192
1255
  readonly total: 0;
1256
+ readonly coverage: 'never-scanned';
1193
1257
  readonly pagination: {
1194
1258
  readonly limit: 100;
1195
1259
  readonly offset: 0;
package/dist/v1/pages.js CHANGED
@@ -23,7 +23,7 @@ export const pageObservationSchema = defineResponseObject({
23
23
  firstSeenAt: schema.string().datetime().nullable(),
24
24
  lastSeenAt: schema.string().datetime().nullable(),
25
25
  resolvedAt: schema.string().datetime().nullable(),
26
- resolution: schema.enum(['fixed', 'removed', 'excluded', 'unmonitored']).nullable(),
26
+ resolution: schema.enum(['fixed', 'removed', 'excluded', 'unmonitored', 'expired']).nullable(),
27
27
  }, {
28
28
  url: schema.string().url(),
29
29
  path: schema.string(),
@@ -35,7 +35,7 @@ export const pageObservationSchema = defineResponseObject({
35
35
  firstSeenAt: schema.string().datetime().nullable(),
36
36
  lastSeenAt: schema.string().datetime().nullable(),
37
37
  resolvedAt: schema.string().datetime().nullable(),
38
- resolution: schema.enum(['fixed', 'removed', 'excluded', 'unmonitored']).nullable(),
38
+ resolution: schema.enum(['fixed', 'removed', 'excluded', 'unmonitored', 'expired']).nullable(),
39
39
  });
40
40
  export const pageLighthouseSchema = defineResponseObject({
41
41
  scanId: schema.string().min(1),
@@ -71,6 +71,14 @@ export const pageRankingKeywordSchema = defineResponseObject({
71
71
  position: schema.number().nullable(),
72
72
  checkedAt: schema.string().datetime().nullable(),
73
73
  });
74
+ /**
75
+ * Whether the empty parts of this payload mean "clean" or "not looked at".
76
+ * `issues-open`: unresolved observations exist. `scanned-clear`: observation
77
+ * sources recorded this Page before and every observation is resolved.
78
+ * `never-scanned`: no observation source has ever recorded this Page, so zero
79
+ * rows and a null Lighthouse are absence of evidence, not a clean bill.
80
+ */
81
+ export const pageObservationCoverageSchema = schema.enum(['never-scanned', 'scanned-clear', 'issues-open']);
74
82
  export const pageInspectDataSchema = defineResponseObject({
75
83
  page: schema.strictObject({
76
84
  url: schema.string().url(),
@@ -79,6 +87,7 @@ export const pageInspectDataSchema = defineResponseObject({
79
87
  observations: schema.strictObject({
80
88
  rows: schema.array(pageObservationSchema.producer),
81
89
  total: schema.number().int().nonnegative(),
90
+ coverage: pageObservationCoverageSchema,
82
91
  pagination: schema.strictObject({
83
92
  limit: schema.number().int().positive(),
84
93
  offset: schema.number().int().nonnegative(),
@@ -99,6 +108,7 @@ export const pageInspectDataSchema = defineResponseObject({
99
108
  observations: schema.looseObject({
100
109
  rows: schema.array(pageObservationSchema.client),
101
110
  total: schema.number().int().nonnegative(),
111
+ coverage: pageObservationCoverageSchema,
102
112
  pagination: schema.looseObject({
103
113
  limit: schema.number().int().positive(),
104
114
  offset: schema.number().int().nonnegative(),
@@ -191,6 +201,7 @@ export const pageInspectOperation = defineOperation({
191
201
  observations: {
192
202
  rows: [],
193
203
  total: 0,
204
+ coverage: 'never-scanned',
194
205
  pagination: { limit: 100, offset: 0, hasMore: false },
195
206
  },
196
207
  performance: { lighthouse: null },