@nuxtseo/protocol 0.5.9 → 0.5.10

package/dist/v1/performance.js

@@ -749,17 +749,29 @@ export const performanceScansOperation = defineOperation({
             }],
     },
 });
+/**
+ * Why the scheduler stopped scanning a Page. `gone`: the URL answers 404 or
+ * 410. `redirected`: it redirects to another page. `unreachable`: Scans keep
+ * timing out or failing. `rejected`: PageSpeed Insights keeps refusing it.
+ * Null while the Page is scanned on schedule.
+ */
+const MONITORED_PAGE_PAUSE_REASONS = ['gone', 'redirected', 'unreachable', 'rejected'];
 export const monitoredPageSchema = defineResponseObject({
     id: schema.string().min(1),
     path: schema.string(),
     source: schema.string().nullable(),
     enabled: schema.boolean(),
+    pauseReason: schema.enum(MONITORED_PAGE_PAUSE_REASONS).nullable(),
+    pausedAt: schema.string().datetime().nullable(),
     lastScanAt: schema.string().datetime().nullable(),
 }, {
     id: schema.string().min(1),
     path: schema.string(),
     source: schema.string().nullable(),
     enabled: schema.boolean(),
+    // A client accepts reasons a newer server adds.
+    pauseReason: schema.string().min(1).nullable().optional(),
+    pausedAt: schema.string().datetime().nullable().optional(),
     lastScanAt: schema.string().datetime().nullable(),
 });
 export const monitoredPagesDataSchema = defineResponseObject({
@@ -806,7 +818,7 @@ export const monitoredPagesOperation = defineOperation({
     lifecycle: { introduced: '1.2.0' },
     docs: {
         summary: 'List monitored Pages',
-        description: 'Returns the Pages this Site scans on a schedule, in display order, with the last time each one was scanned. Start a Scan for a new Page with the Page scan operation.',
+        description: 'Returns the Pages this Site monitors, in display order, with the last time each one was scanned. A Page with a pauseReason is out of the schedule until the owner adds it again. Start a Scan for a new Page with the Page scan operation.',
         tags: ['Pages'],
         examples: [{
                 request: { params: { siteId: 'site_01JXYZ' } },
@@ -814,8 +826,11 @@ export const monitoredPagesOperation = defineOperation({
                     status: 200,
                     body: {
                         data: {
-                            pages: [{ id: 'lhp_01JXYZ', path: '/', source: 'homepage', enabled: true, lastScanAt: '2026-08-10T01:00:00.000Z' }],
-                            total: 1,
+                            pages: [
+                                { id: 'lhp_01JXYZ', path: '/pricing', source: 'auto-gsc', enabled: true, pauseReason: null, pausedAt: null, lastScanAt: '2026-08-10T01:00:00.000Z' },
+                                { id: 'lhp_01JXZA', path: '/blog/old-post', source: 'auto-gsc', enabled: true, pauseReason: 'redirected', pausedAt: '2026-08-09T01:00:00.000Z', lastScanAt: '2026-08-09T01:00:00.000Z' },
+                            ],
+                            total: 2,
                         },
                         meta: { requestId: 'req_01JXYZ', version: '1.0' },
                     },
@@ -937,6 +952,56 @@ export const lcpObservedTraceSchema = schema.discriminatedUnion('_tag', [
         context.addIssue({ code: 'custom', message: 'Trace phases must describe the observed LCP' });
     }
 });
+const scanCruxVitalShape = {
+    p75: schema.number().nonnegative(),
+    rating: fieldVitalRatingSchema,
+};
+const scanCruxVitalClientShape = {
+    p75: schema.number(),
+    rating: schema.string().min(1),
+};
+/** CrUX for one scope as PSI returned it with a Scan. `no_data` means CrUX holds no record for that scope. */
+const scanCruxReadingSchema = {
+    producer: schema.discriminatedUnion('_tag', [
+        schema.strictObject({
+            _tag: schema.literal('measured'),
+            target: schema.string(),
+            lcp: schema.strictObject(scanCruxVitalShape).nullable(),
+            inp: schema.strictObject(scanCruxVitalShape).nullable(),
+            cls: schema.strictObject(scanCruxVitalShape).nullable(),
+        }),
+        schema.strictObject({ _tag: schema.literal('no_data'), target: schema.string() }),
+    ]),
+    client: schema.discriminatedUnion('_tag', [
+        schema.looseObject({
+            _tag: schema.literal('measured'),
+            target: schema.string(),
+            lcp: schema.looseObject(scanCruxVitalClientShape).nullable(),
+            inp: schema.looseObject(scanCruxVitalClientShape).nullable(),
+            cls: schema.looseObject(scanCruxVitalClientShape).nullable(),
+        }),
+        schema.looseObject({ _tag: schema.literal('no_data'), target: schema.string() }),
+    ]),
+};
+/**
+ * The CrUX field reading PSI returned with the Scan: real Chrome users' p75
+ * over the 28 days before it, for the Scan URL and its origin. Null on a Scan
+ * processed before these readings were stored.
+ */
+const scanCruxSchema = {
+    producer: schema.strictObject({
+        formFactor: schema.enum(['PHONE', 'DESKTOP']),
+        capturedAt: schema.string().datetime(),
+        url: scanCruxReadingSchema.producer.nullable(),
+        origin: scanCruxReadingSchema.producer.nullable(),
+    }).nullable(),
+    client: schema.looseObject({
+        formFactor: schema.string().min(1),
+        capturedAt: schema.string().datetime(),
+        url: scanCruxReadingSchema.client.nullable(),
+        origin: scanCruxReadingSchema.client.nullable(),
+    }).nullable(),
+};
 export const performanceScanDetailDataSchema = defineResponseObject({
     ...scanBaseShape,
     fcp: nullableMetricSchema,
@@ -945,6 +1010,7 @@ export const performanceScanDetailDataSchema = defineResponseObject({
     comparison: performanceScanComparisonSchema.producer,
     javascript: schema.strictObject(scanJavascriptShape).nullable(),
     observedTrace: lcpObservedTraceSchema.optional(),
+    crux: scanCruxSchema.producer,
     performanceIssues: schema.array(scanPerformanceIssueSchema.producer),
     cachePolicy: schema.array(scanCachePolicySchema.producer),
     thirdParties: schema.array(scanThirdPartySchema.producer),
@@ -964,6 +1030,7 @@ export const performanceScanDetailDataSchema = defineResponseObject({
     comparison: performanceScanComparisonSchema.client.optional(),
     javascript: schema.looseObject(scanJavascriptShape).nullable().optional(),
     observedTrace: lcpObservedTraceSchema.optional(),
+    crux: scanCruxSchema.client.optional(),
     performanceIssues: schema.array(scanPerformanceIssueSchema.client),
     cachePolicy: schema.array(scanCachePolicySchema.client),
     thirdParties: schema.array(scanThirdPartySchema.client),
@@ -1013,7 +1080,7 @@ export const performanceScanDetailOperation = defineOperation({
     lifecycle: { introduced: '1.2.0' },
     docs: {
         summary: 'Get one Lighthouse Scan',
-        description: 'Returns one Scan with the evidence behind its scores: the wasteful assets, the repeat-visit cache policy, the third-party scripts, the LCP element, and every failing accessibility and best-practices check with the CSS selectors and DOM snippets that failed. It also returns why the Scan started, the Lighthouse version, and the comparison with the previous Scan of the same Page. A failed Scan carries its failureKind and error. Read coverage before quoting a total: elements and checks are both capped per Scan. A null blockingTime or wastedMs is unmeasured, never zero.',
+        description: 'Returns one Scan with the evidence behind its scores: the wasteful assets, the repeat-visit cache policy, the third-party scripts, the LCP element, and every failing accessibility and best-practices check with the CSS selectors and DOM snippets that failed. It also returns why the Scan started, the Lighthouse version, and the comparison with the previous Scan of the same Page. crux is the CrUX p75 for the Scan URL and its origin that PSI returned with the Scan, null on a Scan stored before these readings. A failed Scan carries its failureKind and error. Read coverage before quoting a total: elements and checks are both capped per Scan. A null blockingTime or wastedMs is unmeasured, never zero.',
         tags: ['Pages'],
         examples: [{
                 request: { params: { siteId: 'site_01JXYZ', scanId: 'scan_01JXYZ' } },
@@ -1047,6 +1114,18 @@ export const performanceScanDetailOperation = defineOperation({
                                 ],
                             },
                             javascript: null,
+                            crux: {
+                                formFactor: 'PHONE',
+                                capturedAt: '2026-08-10T00:58:00.000Z',
+                                url: { _tag: 'no_data', target: 'https://example.com/pricing' },
+                                origin: {
+                                    _tag: 'measured',
+                                    target: 'https://example.com',
+                                    lcp: { p75: 2100, rating: 'good' },
+                                    inp: { p75: 180, rating: 'good' },
+                                    cls: { p75: 0.05, rating: 'good' },
+                                },
+                            },
                             performanceIssues: [],
                             cachePolicy: [],
                             thirdParties: [],