@nuxtseo/protocol 0.4.1 → 0.5.1

package/dist/v1/actions.d.ts

@@ -18,6 +18,10 @@ export declare const actionShowQuerySchema: z.ZodObject<{
 export declare const actionResolveBodySchema: z.ZodObject<{
     artifactVersion: z.ZodString;
 }, z.core.$strict>;
+export declare const actionDismissBodySchema: z.ZodObject<{
+    artifactVersion: z.ZodString;
+    note: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
 /**
  * `url` is the URL the finding was observed on and stays exactly as observed —
  * it is what verification re-checks. `redirectsTo` is the read-time answer to
@@ -1229,6 +1233,8 @@ export declare const actionEvidenceGroupSchema: import("./core.js").CompatibleRe
 export declare const actionShowDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
     readonly id: z.ZodString;
     readonly status: z.ZodString;
+    readonly markedAt: z.ZodNullable<z.ZodString>;
+    readonly checkBackAt: z.ZodNullable<z.ZodString>;
     readonly findingType: z.ZodString;
     readonly artifactVersion: z.ZodString;
     readonly assessmentId: z.ZodString;
@@ -1321,6 +1327,8 @@ export declare const actionShowDataSchema: import("./core.js").CompatibleRespons
 }, z.core.$strip>, z.ZodObject<{
     readonly id: z.ZodString;
     readonly status: z.ZodString;
+    readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     readonly findingType: z.ZodString;
     readonly artifactVersion: z.ZodString;
     readonly assessmentId: z.ZodString;
@@ -1415,6 +1423,8 @@ export declare const actionShowResponseSchema: import("./core.js").CompatibleRes
     data: z.ZodObject<{
         readonly id: z.ZodString;
         readonly status: z.ZodString;
+        readonly markedAt: z.ZodNullable<z.ZodString>;
+        readonly checkBackAt: z.ZodNullable<z.ZodString>;
         readonly findingType: z.ZodString;
         readonly artifactVersion: z.ZodString;
         readonly assessmentId: z.ZodString;
@@ -1513,6 +1523,8 @@ export declare const actionShowResponseSchema: import("./core.js").CompatibleRes
     data: z.ZodObject<{
         readonly id: z.ZodString;
         readonly status: z.ZodString;
+        readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         readonly findingType: z.ZodString;
         readonly artifactVersion: z.ZodString;
         readonly assessmentId: z.ZodString;
@@ -1611,6 +1623,8 @@ export declare const actionShowResponseSchema: import("./core.js").CompatibleRes
 export declare const actionResolveDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
     readonly actionId: z.ZodString;
     readonly status: z.ZodString;
+    readonly markedAt: z.ZodNullable<z.ZodString>;
+    readonly checkBackAt: z.ZodNullable<z.ZodString>;
     readonly verification: z.ZodEnum<{
         "metric-watch": "metric-watch";
         "next-assessment": "next-assessment";
@@ -1621,6 +1635,8 @@ export declare const actionResolveDataSchema: import("./core.js").CompatibleResp
 }, z.core.$strip>, z.ZodObject<{
     readonly actionId: z.ZodString;
     readonly status: z.ZodString;
+    readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     readonly verification: z.ZodEnum<{
         "metric-watch": "metric-watch";
         "next-assessment": "next-assessment";
@@ -1633,6 +1649,8 @@ export declare const actionResolveResponseSchema: import("./core.js").Compatible
     data: z.ZodObject<{
         readonly actionId: z.ZodString;
         readonly status: z.ZodString;
+        readonly markedAt: z.ZodNullable<z.ZodString>;
+        readonly checkBackAt: z.ZodNullable<z.ZodString>;
         readonly verification: z.ZodEnum<{
             "metric-watch": "metric-watch";
             "next-assessment": "next-assessment";
@@ -1649,6 +1667,8 @@ export declare const actionResolveResponseSchema: import("./core.js").Compatible
     data: z.ZodObject<{
         readonly actionId: z.ZodString;
         readonly status: z.ZodString;
+        readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         readonly verification: z.ZodEnum<{
             "metric-watch": "metric-watch";
             "next-assessment": "next-assessment";
@@ -2182,6 +2202,8 @@ export declare const actionShowOperation: {
             data: z.ZodObject<{
                 readonly id: z.ZodString;
                 readonly status: z.ZodString;
+                readonly markedAt: z.ZodNullable<z.ZodString>;
+                readonly checkBackAt: z.ZodNullable<z.ZodString>;
                 readonly findingType: z.ZodString;
                 readonly artifactVersion: z.ZodString;
                 readonly assessmentId: z.ZodString;
@@ -2280,6 +2302,8 @@ export declare const actionShowOperation: {
             data: z.ZodObject<{
                 readonly id: z.ZodString;
                 readonly status: z.ZodString;
+                readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                 readonly findingType: z.ZodString;
                 readonly artifactVersion: z.ZodString;
                 readonly assessmentId: z.ZodString;
@@ -2466,6 +2490,8 @@ export declare const actionShowOperation: {
                     readonly data: {
                         readonly id: 'action_01JXYZ';
                         readonly status: 'open';
+                        readonly markedAt: null;
+                        readonly checkBackAt: null;
                         readonly findingType: 'broken-pages';
                         readonly artifactVersion: 'te2:action_01JXYZ:scope';
                         readonly assessmentId: 'assessment_01JXYZ';
@@ -2530,6 +2556,8 @@ export declare const actionResolveOperation: {
             data: z.ZodObject<{
                 readonly actionId: z.ZodString;
                 readonly status: z.ZodString;
+                readonly markedAt: z.ZodNullable<z.ZodString>;
+                readonly checkBackAt: z.ZodNullable<z.ZodString>;
                 readonly verification: z.ZodEnum<{
                     "metric-watch": "metric-watch";
                     "next-assessment": "next-assessment";
@@ -2546,6 +2574,8 @@ export declare const actionResolveOperation: {
             data: z.ZodObject<{
                 readonly actionId: z.ZodString;
                 readonly status: z.ZodString;
+                readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                 readonly verification: z.ZodEnum<{
                     "metric-watch": "metric-watch";
                     "next-assessment": "next-assessment";
@@ -2654,6 +2684,8 @@ export declare const actionResolveOperation: {
                         readonly actionId: 'action_01JXYZ';
                         readonly status: 'open';
                         readonly verification: 'recheck-queued';
+                        readonly markedAt: '2026-08-10T01:30:00.000Z';
+                        readonly checkBackAt: '2026-08-10T01:40:00.000Z';
                     };
                     readonly meta: {
                         readonly requestId: 'req_01JXYZ';
@@ -2696,11 +2728,9 @@ export declare const actionDismissResponseSchema: import("./core.js").Compatible
 }, z.core.$strip>>;
 export type ActionDismiss = z.output<typeof actionDismissDataSchema.client>;
 /**
- * Dismissing is the opposite decision from resolving: the page stays gone.
- * It is admitted only for a broken-page Action whose evidence is complete and
- * shows no internal referrer, so a caller cannot use it to hide work. The same
- * `artifactVersion` fence as resolve applies, so a decision made against stale
- * evidence is rejected rather than applied.
+ * An explicit note records the owner's decision to dismiss reviewed work.
+ * Without a note, only complete, unlinked 404/410 evidence admits dismissal.
+ * Both paths retain the artifactVersion fence and never claim a verified fix.
  */
 export declare const actionDismissOperation: {
     readonly id: 'actions.dismiss';
@@ -2728,6 +2758,7 @@ export declare const actionDismissOperation: {
         readonly headers: null;
         readonly body: z.ZodObject<{
             artifactVersion: z.ZodString;
+            note: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>;
     };
     readonly responses: {
@@ -2828,7 +2859,7 @@ export declare const actionDismissOperation: {
     };
     readonly docs: {
         readonly summary: 'Dismiss an action';
-        readonly description: 'Dismisses a broken-page action when its evidence is complete and shows no internal referrers, so the removed page stays removed. It is rejected when the action has other evidence, when it is already decided, or when the artifactVersion no longer matches. The action stays dismissed until a person restores it.';
+        readonly description: 'Records an owner decision to dismiss an action when a note explains why it is intentional or incorrect. Without a note, only complete 404 or 410 evidence with no internal referrers is accepted. Stale details and decided actions are rejected. Dismissal preserves observations and does not verify a fix. The action stays dismissed until a person restores it.';
         readonly tags: readonly ["Actions"];
         readonly examples: readonly [{
             readonly request: {
@@ -2854,6 +2885,31 @@ export declare const actionDismissOperation: {
                     };
                 };
             };
+        }, {
+            readonly request: {
+                readonly params: {
+                    readonly siteId: 'site_01JXYZ';
+                    readonly actionId: 'action_01JXYZ';
+                };
+                readonly body: {
+                    readonly artifactVersion: 'te2:action_01JXYZ:scope';
+                    readonly note: 'Temporary retired sitemap. Review after the recovery gate.';
+                };
+            };
+            readonly response: {
+                readonly status: 200;
+                readonly body: {
+                    readonly data: {
+                        readonly actionId: 'action_01JXYZ';
+                        readonly status: 'dismissed';
+                        readonly message: 'Dismissed. Your note is saved. No fix was verified.';
+                    };
+                    readonly meta: {
+                        readonly requestId: 'req_01JXYZ';
+                        readonly version: '1.0';
+                    };
+                };
+            };
         }];
     };
 };
@@ -3372,6 +3428,8 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
                 data: z.ZodObject<{
                     readonly id: z.ZodString;
                     readonly status: z.ZodString;
+                    readonly markedAt: z.ZodNullable<z.ZodString>;
+                    readonly checkBackAt: z.ZodNullable<z.ZodString>;
                     readonly findingType: z.ZodString;
                     readonly artifactVersion: z.ZodString;
                     readonly assessmentId: z.ZodString;
@@ -3470,6 +3528,8 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
                 data: z.ZodObject<{
                     readonly id: z.ZodString;
                     readonly status: z.ZodString;
+                    readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                     readonly findingType: z.ZodString;
                     readonly artifactVersion: z.ZodString;
                     readonly assessmentId: z.ZodString;
@@ -3656,6 +3716,8 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
                         readonly data: {
                             readonly id: 'action_01JXYZ';
                             readonly status: 'open';
+                            readonly markedAt: null;
+                            readonly checkBackAt: null;
                             readonly findingType: 'broken-pages';
                             readonly artifactVersion: 'te2:action_01JXYZ:scope';
                             readonly assessmentId: 'assessment_01JXYZ';
@@ -3720,6 +3782,8 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
                 data: z.ZodObject<{
                     readonly actionId: z.ZodString;
                     readonly status: z.ZodString;
+                    readonly markedAt: z.ZodNullable<z.ZodString>;
+                    readonly checkBackAt: z.ZodNullable<z.ZodString>;
                     readonly verification: z.ZodEnum<{
                         "metric-watch": "metric-watch";
                         "next-assessment": "next-assessment";
@@ -3736,6 +3800,8 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
                 data: z.ZodObject<{
                     readonly actionId: z.ZodString;
                     readonly status: z.ZodString;
+                    readonly markedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                    readonly checkBackAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                     readonly verification: z.ZodEnum<{
                         "metric-watch": "metric-watch";
                         "next-assessment": "next-assessment";
@@ -3844,6 +3910,8 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
                             readonly actionId: 'action_01JXYZ';
                             readonly status: 'open';
                             readonly verification: 'recheck-queued';
+                            readonly markedAt: '2026-08-10T01:30:00.000Z';
+                            readonly checkBackAt: '2026-08-10T01:40:00.000Z';
                         };
                         readonly meta: {
                             readonly requestId: 'req_01JXYZ';
@@ -3880,6 +3948,7 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
             readonly headers: null;
             readonly body: z.ZodObject<{
                 artifactVersion: z.ZodString;
+                note: z.ZodOptional<z.ZodString>;
             }, z.core.$strict>;
         };
         readonly responses: {
@@ -3980,7 +4049,7 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
         };
         readonly docs: {
             readonly summary: 'Dismiss an action';
-            readonly description: 'Dismisses a broken-page action when its evidence is complete and shows no internal referrers, so the removed page stays removed. It is rejected when the action has other evidence, when it is already decided, or when the artifactVersion no longer matches. The action stays dismissed until a person restores it.';
+            readonly description: 'Records an owner decision to dismiss an action when a note explains why it is intentional or incorrect. Without a note, only complete 404 or 410 evidence with no internal referrers is accepted. Stale details and decided actions are rejected. Dismissal preserves observations and does not verify a fix. The action stays dismissed until a person restores it.';
             readonly tags: readonly ["Actions"];
             readonly examples: readonly [{
                 readonly request: {
@@ -4006,6 +4075,31 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
                         };
                     };
                 };
+            }, {
+                readonly request: {
+                    readonly params: {
+                        readonly siteId: 'site_01JXYZ';
+                        readonly actionId: 'action_01JXYZ';
+                    };
+                    readonly body: {
+                        readonly artifactVersion: 'te2:action_01JXYZ:scope';
+                        readonly note: 'Temporary retired sitemap. Review after the recovery gate.';
+                    };
+                };
+                readonly response: {
+                    readonly status: 200;
+                    readonly body: {
+                        readonly data: {
+                            readonly actionId: 'action_01JXYZ';
+                            readonly status: 'dismissed';
+                            readonly message: 'Dismissed. Your note is saved. No fix was verified.';
+                        };
+                        readonly meta: {
+                            readonly requestId: 'req_01JXYZ';
+                            readonly version: '1.0';
+                        };
+                    };
+                };
             }];
         };
     };

package/dist/v1/actions.js

@@ -19,6 +19,10 @@ export const actionShowQuerySchema = schema.strictObject({
 export const actionResolveBodySchema = schema.strictObject({
     artifactVersion: schema.string().min(1),
 });
+export const actionDismissBodySchema = schema.strictObject({
+    artifactVersion: schema.string().min(1),
+    note: schema.string().trim().min(1).max(2000).optional(),
+});
 /**
  * `url` is the URL the finding was observed on and stays exactly as observed —
  * it is what verification re-checks. `redirectsTo` is the read-time answer to
@@ -292,6 +296,8 @@ export const actionEvidenceGroupSchema = defineResponseObject({
 export const actionShowDataSchema = defineResponseObject({
     id: schema.string().min(1),
     status: schema.string().min(1),
+    markedAt: schema.string().datetime().nullable(),
+    checkBackAt: schema.string().datetime().nullable(),
     findingType: schema.string().min(1),
     artifactVersion: schema.string().min(1),
     assessmentId: schema.string().min(1),
@@ -309,6 +315,8 @@ export const actionShowDataSchema = defineResponseObject({
 }, {
     id: schema.string().min(1),
     status: schema.string().min(1),
+    markedAt: schema.string().datetime().nullable().optional(),
+    checkBackAt: schema.string().datetime().nullable().optional(),
     findingType: schema.string().min(1),
     artifactVersion: schema.string().min(1),
     assessmentId: schema.string().min(1),
@@ -328,10 +336,14 @@ export const actionShowResponseSchema = defineSuccessEnvelope(actionShowDataSche
 export const actionResolveDataSchema = defineResponseObject({
     actionId: schema.string().min(1),
     status: schema.string().min(1),
+    markedAt: schema.string().datetime().nullable(),
+    checkBackAt: schema.string().datetime().nullable(),
     verification: schema.enum(['recheck-queued', 'scan-queued', 'next-assessment', 'metric-watch', 'user-resolved']),
 }, {
     actionId: schema.string().min(1),
     status: schema.string().min(1),
+    markedAt: schema.string().datetime().nullable().optional(),
+    checkBackAt: schema.string().datetime().nullable().optional(),
     verification: schema.enum(['recheck-queued', 'scan-queued', 'next-assessment', 'metric-watch', 'user-resolved']),
 });
 export const actionResolveResponseSchema = defineSuccessEnvelope(actionResolveDataSchema);
@@ -432,6 +444,8 @@ export const actionShowOperation = defineOperation({
                         data: {
                             id: 'action_01JXYZ',
                             status: 'open',
+                            markedAt: null,
+                            checkBackAt: null,
                             findingType: 'broken-pages',
                             artifactVersion: 'te2:action_01JXYZ:scope',
                             assessmentId: 'assessment_01JXYZ',
@@ -501,7 +515,7 @@ export const actionResolveOperation = defineOperation({
                 response: {
                     status: 200,
                     body: {
-                        data: { actionId: 'action_01JXYZ', status: 'open', verification: 'recheck-queued' },
+                        data: { actionId: 'action_01JXYZ', status: 'open', verification: 'recheck-queued', markedAt: '2026-08-10T01:30:00.000Z', checkBackAt: '2026-08-10T01:40:00.000Z' },
                         meta: { requestId: 'req_01JXYZ', version: '1.0' },
                     },
                 },
@@ -519,11 +533,9 @@ export const actionDismissDataSchema = defineResponseObject({
 });
 export const actionDismissResponseSchema = defineSuccessEnvelope(actionDismissDataSchema);
 /**
- * Dismissing is the opposite decision from resolving: the page stays gone.
- * It is admitted only for a broken-page Action whose evidence is complete and
- * shows no internal referrer, so a caller cannot use it to hide work. The same
- * `artifactVersion` fence as resolve applies, so a decision made against stale
- * evidence is rejected rather than applied.
+ * An explicit note records the owner's decision to dismiss reviewed work.
+ * Without a note, only complete, unlinked 404/410 evidence admits dismissal.
+ * Both paths retain the artifactVersion fence and never claim a verified fix.
  */
 export const actionDismissOperation = defineOperation({
     id: 'actions.dismiss',
@@ -537,7 +549,7 @@ export const actionDismissOperation = defineOperation({
         minimumRole: 'member',
         ownership: 'site',
     },
-    request: { params: actionParamsSchema, query: null, headers: null, body: actionResolveBodySchema },
+    request: { params: actionParamsSchema, query: null, headers: null, body: actionDismissBodySchema },
     responses: { 200: actionDismissResponseSchema },
     errors: [
         'invalid_request',
@@ -566,7 +578,7 @@ export const actionDismissOperation = defineOperation({
     lifecycle: { introduced: '1.2.0' },
     docs: {
         summary: 'Dismiss an action',
-        description: 'Dismisses a broken-page action when its evidence is complete and shows no internal referrers, so the removed page stays removed. It is rejected when the action has other evidence, when it is already decided, or when the artifactVersion no longer matches. The action stays dismissed until a person restores it.',
+        description: 'Records an owner decision to dismiss an action when a note explains why it is intentional or incorrect. Without a note, only complete 404 or 410 evidence with no internal referrers is accepted. Stale details and decided actions are rejected. Dismissal preserves observations and does not verify a fix. The action stays dismissed until a person restores it.',
         tags: ['Actions'],
         examples: [{
                 request: {
@@ -580,6 +592,21 @@ export const actionDismissOperation = defineOperation({
                         meta: { requestId: 'req_01JXYZ', version: '1.0' },
                     },
                 },
+            }, {
+                request: {
+                    params: { siteId: 'site_01JXYZ', actionId: 'action_01JXYZ' },
+                    body: {
+                        artifactVersion: 'te2:action_01JXYZ:scope',
+                        note: 'Temporary retired sitemap. Review after the recovery gate.',
+                    },
+                },
+                response: {
+                    status: 200,
+                    body: {
+                        data: { actionId: 'action_01JXYZ', status: 'dismissed', message: 'Dismissed. Your note is saved. No fix was verified.' },
+                        meta: { requestId: 'req_01JXYZ', version: '1.0' },
+                    },
+                },
             }],
     },
 });