@nuxtseo/protocol 0.1.1 → 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 (8) 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 +254 -0
  4. package/dist/v1/actions.js +16 -0
  5. package/dist/v1/pages.d.ts +54 -0
  6. package/dist/v1/pages.js +11 -0
  7. package/generated/openapi.v1.json +1 -1
  8. package/package.json +1 -1
package/dist/v1/pages.d.ts CHANGED
@@ -101,6 +101,18 @@ export declare const pageRankingKeywordSchema: import("./core.js").CompatibleRes
101
101
  readonly position: z.ZodNullable<z.ZodNumber>;
102
102
  readonly checkedAt: z.ZodNullable<z.ZodString>;
103
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
+ }>;
104
116
  export declare const pageInspectDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
105
117
  readonly page: z.ZodObject<{
106
118
  url: z.ZodString;
@@ -131,6 +143,11 @@ export declare const pageInspectDataSchema: import("./core.js").CompatibleRespon
131
143
  }>>;
132
144
  }, z.core.$strip>>;
133
145
  total: z.ZodNumber;
146
+ coverage: z.ZodEnum<{
147
+ "issues-open": "issues-open";
148
+ "never-scanned": "never-scanned";
149
+ "scanned-clear": "scanned-clear";
150
+ }>;
134
151
  pagination: z.ZodObject<{
135
152
  limit: z.ZodNumber;
136
153
  offset: z.ZodNumber;
@@ -192,6 +209,11 @@ export declare const pageInspectDataSchema: import("./core.js").CompatibleRespon
192
209
  }>>;
193
210
  }, z.core.$strip>>;
194
211
  total: z.ZodNumber;
212
+ coverage: z.ZodEnum<{
213
+ "issues-open": "issues-open";
214
+ "never-scanned": "never-scanned";
215
+ "scanned-clear": "scanned-clear";
216
+ }>;
195
217
  pagination: z.ZodObject<{
196
218
  limit: z.ZodNumber;
197
219
  offset: z.ZodNumber;
@@ -255,6 +277,11 @@ export declare const pageInspectResponseSchema: import("./core.js").CompatibleRe
255
277
  }>>;
256
278
  }, z.core.$strip>>;
257
279
  total: z.ZodNumber;
280
+ coverage: z.ZodEnum<{
281
+ "issues-open": "issues-open";
282
+ "never-scanned": "never-scanned";
283
+ "scanned-clear": "scanned-clear";
284
+ }>;
258
285
  pagination: z.ZodObject<{
259
286
  limit: z.ZodNumber;
260
287
  offset: z.ZodNumber;
@@ -322,6 +349,11 @@ export declare const pageInspectResponseSchema: import("./core.js").CompatibleRe
322
349
  }>>;
323
350
  }, z.core.$strip>>;
324
351
  total: z.ZodNumber;
352
+ coverage: z.ZodEnum<{
353
+ "issues-open": "issues-open";
354
+ "never-scanned": "never-scanned";
355
+ "scanned-clear": "scanned-clear";
356
+ }>;
325
357
  pagination: z.ZodObject<{
326
358
  limit: z.ZodNumber;
327
359
  offset: z.ZodNumber;
@@ -517,6 +549,11 @@ export declare const pageInspectOperation: {
517
549
  }>>;
518
550
  }, z.core.$strip>>;
519
551
  total: z.ZodNumber;
552
+ coverage: z.ZodEnum<{
553
+ "issues-open": "issues-open";
554
+ "never-scanned": "never-scanned";
555
+ "scanned-clear": "scanned-clear";
556
+ }>;
520
557
  pagination: z.ZodObject<{
521
558
  limit: z.ZodNumber;
522
559
  offset: z.ZodNumber;
@@ -584,6 +621,11 @@ export declare const pageInspectOperation: {
584
621
  }>>;
585
622
  }, z.core.$strip>>;
586
623
  total: z.ZodNumber;
624
+ coverage: z.ZodEnum<{
625
+ "issues-open": "issues-open";
626
+ "never-scanned": "never-scanned";
627
+ "scanned-clear": "scanned-clear";
628
+ }>;
587
629
  pagination: z.ZodObject<{
588
630
  limit: z.ZodNumber;
589
631
  offset: z.ZodNumber;
@@ -719,6 +761,7 @@ export declare const pageInspectOperation: {
719
761
  readonly observations: {
720
762
  readonly rows: readonly [];
721
763
  readonly total: 0;
764
+ readonly coverage: 'never-scanned';
722
765
  readonly pagination: {
723
766
  readonly limit: 100;
724
767
  readonly offset: 0;
@@ -998,6 +1041,11 @@ export declare const pagesV1Registry: import("./core.js").PublicV1Registry<{
998
1041
  }>>;
999
1042
  }, z.core.$strip>>;
1000
1043
  total: z.ZodNumber;
1044
+ coverage: z.ZodEnum<{
1045
+ "issues-open": "issues-open";
1046
+ "never-scanned": "never-scanned";
1047
+ "scanned-clear": "scanned-clear";
1048
+ }>;
1001
1049
  pagination: z.ZodObject<{
1002
1050
  limit: z.ZodNumber;
1003
1051
  offset: z.ZodNumber;
@@ -1065,6 +1113,11 @@ export declare const pagesV1Registry: import("./core.js").PublicV1Registry<{
1065
1113
  }>>;
1066
1114
  }, z.core.$strip>>;
1067
1115
  total: z.ZodNumber;
1116
+ coverage: z.ZodEnum<{
1117
+ "issues-open": "issues-open";
1118
+ "never-scanned": "never-scanned";
1119
+ "scanned-clear": "scanned-clear";
1120
+ }>;
1068
1121
  pagination: z.ZodObject<{
1069
1122
  limit: z.ZodNumber;
1070
1123
  offset: z.ZodNumber;
@@ -1200,6 +1253,7 @@ export declare const pagesV1Registry: import("./core.js").PublicV1Registry<{
1200
1253
  readonly observations: {
1201
1254
  readonly rows: readonly [];
1202
1255
  readonly total: 0;
1256
+ readonly coverage: 'never-scanned';
1203
1257
  readonly pagination: {
1204
1258
  readonly limit: 100;
1205
1259
  readonly offset: 0;
package/dist/v1/pages.js CHANGED
@@ -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 },