npm - @nuxtseo/protocol - Versions diffs - 0.2.0 → 0.2.1 - Mend

@nuxtseo/protocol 0.2.0 → 0.2.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 (7) hide show

package/dist/v1/account.d.ts CHANGED Viewed

@@ -458,6 +458,7 @@ export declare const accountTokenDataSchema: import("./core.js").CompatibleRespo
         "audit:read": "audit:read";
         "content:read": "content:read";
         "content:write": "content:write";
+        "feedback:write": "feedback:write";
         "page:read": "page:read";
         "page:write": "page:write";
         "research:read": "research:read";
@@ -507,6 +508,7 @@ export declare const accountTokenDataSchema: import("./core.js").CompatibleRespo
         "audit:read": "audit:read";
         "content:read": "content:read";
         "content:write": "content:write";
+        "feedback:write": "feedback:write";
         "page:read": "page:read";
         "page:write": "page:write";
         "research:read": "research:read";
@@ -558,6 +560,7 @@ export declare const accountTokenResponseSchema: import("./core.js").CompatibleR
             "audit:read": "audit:read";
             "content:read": "content:read";
             "content:write": "content:write";
+            "feedback:write": "feedback:write";
             "page:read": "page:read";
             "page:write": "page:write";
             "research:read": "research:read";
@@ -613,6 +616,7 @@ export declare const accountTokenResponseSchema: import("./core.js").CompatibleR
             "audit:read": "audit:read";
             "content:read": "content:read";
             "content:write": "content:write";
+            "feedback:write": "feedback:write";
             "page:read": "page:read";
             "page:write": "page:write";
             "research:read": "research:read";
@@ -695,6 +699,7 @@ export declare const accountTokenOperation: {
                     "audit:read": "audit:read";
                     "content:read": "content:read";
                     "content:write": "content:write";
+                    "feedback:write": "feedback:write";
                     "page:read": "page:read";
                     "page:write": "page:write";
                     "research:read": "research:read";
@@ -750,6 +755,7 @@ export declare const accountTokenOperation: {
                     "audit:read": "audit:read";
                     "content:read": "content:read";
                     "content:write": "content:write";
+                    "feedback:write": "feedback:write";
                     "page:read": "page:read";
                     "page:write": "page:write";
                     "research:read": "research:read";
@@ -897,6 +903,190 @@ export declare const accountTokenOperation: {
         }];
     };
 };
+export declare const accountFeedbackBodySchema: z.ZodObject<{
+    command: z.ZodString;
+    comment: z.ZodString;
+    agent: z.ZodString;
+    cliVersion: z.ZodString;
+    intent: z.ZodDefault<z.ZodEnum<{
+        bug: "bug";
+        improvement: "improvement";
+    }>>;
+    requestId: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export declare const accountFeedbackResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
+    data: z.ZodObject<{
+        readonly id: z.ZodString;
+        readonly status: z.ZodLiteral<"new">;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        requestId: z.ZodString;
+        version: z.ZodLiteral<"1.0">;
+    }, z.core.$strict>;
+}, z.core.$strip>, z.ZodObject<{
+    data: z.ZodObject<{
+        readonly id: z.ZodString;
+        readonly status: z.ZodLiteral<"new">;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        requestId: z.ZodString;
+        version: z.ZodLiteral<"1.0">;
+    }, z.core.$loose>;
+}, z.core.$strip>>;
+export declare const accountFeedbackOperation: {
+    readonly id: 'account.feedback';
+    readonly method: 'POST';
+    readonly path: '/api/v1/account/feedback';
+    readonly visibility: 'public';
+    readonly semantics: {
+        readonly kind: 'mutation';
+        readonly sideEffects: 'state';
+        readonly retry: 'never';
+        readonly readConsistency: null;
+    };
+    readonly auth: {
+        readonly credentials: readonly ["session", "api_token"];
+        readonly scopes: readonly ["feedback:write"];
+        readonly minimumRole: 'viewer';
+        readonly ownership: 'team';
+    };
+    readonly request: {
+        readonly params: null;
+        readonly query: null;
+        readonly headers: null;
+        readonly body: z.ZodObject<{
+            command: z.ZodString;
+            comment: z.ZodString;
+            agent: z.ZodString;
+            cliVersion: z.ZodString;
+            intent: z.ZodDefault<z.ZodEnum<{
+                bug: "bug";
+                improvement: "improvement";
+            }>>;
+            requestId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+    };
+    readonly responses: {
+        readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
+            data: z.ZodObject<{
+                readonly id: z.ZodString;
+                readonly status: z.ZodLiteral<"new">;
+            }, z.core.$strip>;
+            meta: z.ZodObject<{
+                requestId: z.ZodString;
+                version: z.ZodLiteral<"1.0">;
+            }, z.core.$strict>;
+        }, z.core.$strip>, z.ZodObject<{
+            data: z.ZodObject<{
+                readonly id: z.ZodString;
+                readonly status: z.ZodLiteral<"new">;
+            }, z.core.$strip>;
+            meta: z.ZodObject<{
+                requestId: z.ZodString;
+                version: z.ZodLiteral<"1.0">;
+            }, z.core.$loose>;
+        }, z.core.$strip>>;
+    };
+    readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "rate_limited", "contract_violation", "internal_error"];
+    readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
+        readonly error: z.ZodObject<{
+            code: z.ZodEnum<{
+                auth_expired: "auth_expired";
+                conflict: "conflict";
+                contract_violation: "contract_violation";
+                entitlement_required: "entitlement_required";
+                forbidden: "forbidden";
+                internal_error: "internal_error";
+                invalid_request: "invalid_request";
+                not_found: "not_found";
+                provider_unavailable: "provider_unavailable";
+                quota_exhausted: "quota_exhausted";
+                rate_limited: "rate_limited";
+                site_ambiguous: "site_ambiguous";
+                stale_evidence: "stale_evidence";
+                unauthorized: "unauthorized";
+            }>;
+            message: z.ZodString;
+            requestId: z.ZodString;
+            retryable: z.ZodBoolean;
+            details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, z.core.$strict>;
+    }, z.core.$strip>, z.ZodObject<{
+        readonly error: z.ZodObject<{
+            code: z.ZodEnum<{
+                auth_expired: "auth_expired";
+                conflict: "conflict";
+                contract_violation: "contract_violation";
+                entitlement_required: "entitlement_required";
+                forbidden: "forbidden";
+                internal_error: "internal_error";
+                invalid_request: "invalid_request";
+                not_found: "not_found";
+                provider_unavailable: "provider_unavailable";
+                quota_exhausted: "quota_exhausted";
+                rate_limited: "rate_limited";
+                site_ambiguous: "site_ambiguous";
+                stale_evidence: "stale_evidence";
+                unauthorized: "unauthorized";
+            }>;
+            message: z.ZodString;
+            requestId: z.ZodString;
+            retryable: z.ZodBoolean;
+            details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, z.core.$loose>;
+    }, z.core.$strip>>;
+    readonly resources: {
+        readonly reads: readonly [];
+        readonly changes: readonly [{
+            readonly type: 'account.feedback';
+            readonly idFrom: 'team.id';
+        }];
+    };
+    readonly policy: {
+        readonly rate: {
+            readonly name: 'cli-feedback';
+            readonly limit: 10;
+            readonly windowSeconds: 3600;
+        };
+        readonly idempotency: {
+            readonly _tag: 'none';
+        };
+        readonly entitlement: null;
+        readonly meter: null;
+    };
+    readonly lifecycle: {
+        readonly introduced: '1.0.0';
+    };
+    readonly docs: {
+        readonly summary: 'Submit CLI feedback';
+        readonly description: 'Stores an agent report in the existing feedback queue. Operators track fixes there and review unresolved reports during health checks. No Site or paid subscription is required. Send sanitized reproduction details only. This operation does not retry.';
+        readonly tags: readonly ["Account"];
+        readonly examples: readonly [{
+            readonly request: {
+                readonly body: {
+                    readonly command: 'search cohorts';
+                    readonly comment: 'Agent report by Codex. Expected a reason for missing data. Received an empty list.';
+                    readonly agent: 'Codex';
+                    readonly cliVersion: '0.2.1';
+                    readonly intent: 'bug';
+                };
+            };
+            readonly response: {
+                readonly status: 200;
+                readonly body: {
+                    readonly data: {
+                        readonly id: 'fb_01JXYZ';
+                        readonly status: 'new';
+                    };
+                    readonly meta: {
+                        readonly requestId: 'req_01JXYZ';
+                        readonly version: '1.0';
+                    };
+                };
+            };
+        }];
+    };
+};
 export declare const accountV1Registry: import("./core.js").PublicV1Registry<{
     readonly usage: {
         readonly id: 'account.usage';
@@ -1158,6 +1348,7 @@ export declare const accountV1Registry: import("./core.js").PublicV1Registry<{
                         "audit:read": "audit:read";
                         "content:read": "content:read";
                         "content:write": "content:write";
+                        "feedback:write": "feedback:write";
                         "page:read": "page:read";
                         "page:write": "page:write";
                         "research:read": "research:read";
@@ -1213,6 +1404,7 @@ export declare const accountV1Registry: import("./core.js").PublicV1Registry<{
                         "audit:read": "audit:read";
                         "content:read": "content:read";
                         "content:write": "content:write";
+                        "feedback:write": "feedback:write";
                         "page:read": "page:read";
                         "page:write": "page:write";
                         "research:read": "research:read";
@@ -1360,4 +1552,158 @@ export declare const accountV1Registry: import("./core.js").PublicV1Registry<{
             }];
         };
     };
+    readonly feedback: {
+        readonly id: 'account.feedback';
+        readonly method: 'POST';
+        readonly path: '/api/v1/account/feedback';
+        readonly visibility: 'public';
+        readonly semantics: {
+            readonly kind: 'mutation';
+            readonly sideEffects: 'state';
+            readonly retry: 'never';
+            readonly readConsistency: null;
+        };
+        readonly auth: {
+            readonly credentials: readonly ["session", "api_token"];
+            readonly scopes: readonly ["feedback:write"];
+            readonly minimumRole: 'viewer';
+            readonly ownership: 'team';
+        };
+        readonly request: {
+            readonly params: null;
+            readonly query: null;
+            readonly headers: null;
+            readonly body: z.ZodObject<{
+                command: z.ZodString;
+                comment: z.ZodString;
+                agent: z.ZodString;
+                cliVersion: z.ZodString;
+                intent: z.ZodDefault<z.ZodEnum<{
+                    bug: "bug";
+                    improvement: "improvement";
+                }>>;
+                requestId: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+        };
+        readonly responses: {
+            readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
+                data: z.ZodObject<{
+                    readonly id: z.ZodString;
+                    readonly status: z.ZodLiteral<"new">;
+                }, z.core.$strip>;
+                meta: z.ZodObject<{
+                    requestId: z.ZodString;
+                    version: z.ZodLiteral<"1.0">;
+                }, z.core.$strict>;
+            }, z.core.$strip>, z.ZodObject<{
+                data: z.ZodObject<{
+                    readonly id: z.ZodString;
+                    readonly status: z.ZodLiteral<"new">;
+                }, z.core.$strip>;
+                meta: z.ZodObject<{
+                    requestId: z.ZodString;
+                    version: z.ZodLiteral<"1.0">;
+                }, z.core.$loose>;
+            }, z.core.$strip>>;
+        };
+        readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "rate_limited", "contract_violation", "internal_error"];
+        readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
+            readonly error: z.ZodObject<{
+                code: z.ZodEnum<{
+                    auth_expired: "auth_expired";
+                    conflict: "conflict";
+                    contract_violation: "contract_violation";
+                    entitlement_required: "entitlement_required";
+                    forbidden: "forbidden";
+                    internal_error: "internal_error";
+                    invalid_request: "invalid_request";
+                    not_found: "not_found";
+                    provider_unavailable: "provider_unavailable";
+                    quota_exhausted: "quota_exhausted";
+                    rate_limited: "rate_limited";
+                    site_ambiguous: "site_ambiguous";
+                    stale_evidence: "stale_evidence";
+                    unauthorized: "unauthorized";
+                }>;
+                message: z.ZodString;
+                requestId: z.ZodString;
+                retryable: z.ZodBoolean;
+                details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            }, z.core.$strict>;
+        }, z.core.$strip>, z.ZodObject<{
+            readonly error: z.ZodObject<{
+                code: z.ZodEnum<{
+                    auth_expired: "auth_expired";
+                    conflict: "conflict";
+                    contract_violation: "contract_violation";
+                    entitlement_required: "entitlement_required";
+                    forbidden: "forbidden";
+                    internal_error: "internal_error";
+                    invalid_request: "invalid_request";
+                    not_found: "not_found";
+                    provider_unavailable: "provider_unavailable";
+                    quota_exhausted: "quota_exhausted";
+                    rate_limited: "rate_limited";
+                    site_ambiguous: "site_ambiguous";
+                    stale_evidence: "stale_evidence";
+                    unauthorized: "unauthorized";
+                }>;
+                message: z.ZodString;
+                requestId: z.ZodString;
+                retryable: z.ZodBoolean;
+                details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            }, z.core.$loose>;
+        }, z.core.$strip>>;
+        readonly resources: {
+            readonly reads: readonly [];
+            readonly changes: readonly [{
+                readonly type: 'account.feedback';
+                readonly idFrom: 'team.id';
+            }];
+        };
+        readonly policy: {
+            readonly rate: {
+                readonly name: 'cli-feedback';
+                readonly limit: 10;
+                readonly windowSeconds: 3600;
+            };
+            readonly idempotency: {
+                readonly _tag: 'none';
+            };
+            readonly entitlement: null;
+            readonly meter: null;
+        };
+        readonly lifecycle: {
+            readonly introduced: '1.0.0';
+        };
+        readonly docs: {
+            readonly summary: 'Submit CLI feedback';
+            readonly description: 'Stores an agent report in the existing feedback queue. Operators track fixes there and review unresolved reports during health checks. No Site or paid subscription is required. Send sanitized reproduction details only. This operation does not retry.';
+            readonly tags: readonly ["Account"];
+            readonly examples: readonly [{
+                readonly request: {
+                    readonly body: {
+                        readonly command: 'search cohorts';
+                        readonly comment: 'Agent report by Codex. Expected a reason for missing data. Received an empty list.';
+                        readonly agent: 'Codex';
+                        readonly cliVersion: '0.2.1';
+                        readonly intent: 'bug';
+                    };
+                };
+                readonly response: {
+                    readonly status: 200;
+                    readonly body: {
+                        readonly data: {
+                            readonly id: 'fb_01JXYZ';
+                            readonly status: 'new';
+                        };
+                        readonly meta: {
+                            readonly requestId: 'req_01JXYZ';
+                            readonly version: '1.0';
+                        };
+                    };
+                };
+            }];
+        };
+    };
 }>;

package/dist/v1/account.js CHANGED Viewed

@@ -233,10 +233,69 @@ export const accountTokenOperation = defineOperation({
             }],
     },
 });
+export const accountFeedbackBodySchema = schema.strictObject({
+    command: schema.string().trim().min(1).max(200),
+    comment: schema.string().trim().min(1).max(2000),
+    agent: schema.string().trim().min(1).max(100),
+    cliVersion: schema.string().trim().min(1).max(64),
+    intent: schema.enum(['bug', 'improvement']).default('bug'),
+    requestId: schema.string().trim().min(1).max(128).optional(),
+});
+export const accountFeedbackResponseSchema = defineSuccessEnvelope(defineResponseObject({
+    id: schema.string().min(1),
+    status: schema.literal('new'),
+}));
+export const accountFeedbackOperation = defineOperation({
+    id: 'account.feedback',
+    method: 'POST',
+    path: '/api/v1/account/feedback',
+    visibility: 'public',
+    semantics: { kind: 'mutation', sideEffects: 'state', retry: 'never', readConsistency: null },
+    auth: {
+        credentials: ['session', 'api_token'],
+        scopes: ['feedback:write'],
+        minimumRole: 'viewer',
+        ownership: 'team',
+    },
+    request: { params: null, query: null, headers: null, body: accountFeedbackBodySchema },
+    responses: { 200: accountFeedbackResponseSchema },
+    errors: ['invalid_request', 'unauthorized', 'auth_expired', 'forbidden', 'rate_limited', 'contract_violation', 'internal_error'],
+    errorResponse: publicV1ErrorEnvelope,
+    resources: {
+        reads: [],
+        changes: [{ type: 'account.feedback', idFrom: 'team.id' }],
+    },
+    policy: {
+        rate: { name: 'cli-feedback', limit: 10, windowSeconds: 3600 },
+        idempotency: { _tag: 'none' },
+        entitlement: null,
+        meter: null,
+    },
+    lifecycle: { introduced: '1.0.0' },
+    docs: {
+        summary: 'Submit CLI feedback',
+        description: 'Stores an agent report in the existing feedback queue. Operators track fixes there and review unresolved reports during health checks. No Site or paid subscription is required. Send sanitized reproduction details only. This operation does not retry.',
+        tags: ['Account'],
+        examples: [{
+                request: { body: {
+                        command: 'search cohorts',
+                        comment: 'Agent report by Codex. Expected a reason for missing data. Received an empty list.',
+                        agent: 'Codex',
+                        cliVersion: '0.2.1',
+                        intent: 'bug',
+                    } },
+                response: { status: 200, body: {
+                        data: { id: 'fb_01JXYZ', status: 'new' },
+                        meta: { requestId: 'req_01JXYZ', version: '1.0' },
+                    } },
+            }],
+    },
+});
 export const accountV1Registry = defineRegistry({
     feature: 'account',
     operations: {
         usage: accountUsageOperation,
         token: accountTokenOperation,
+        feedback: accountFeedbackOperation,
     },
 });

package/dist/v1/core.d.ts CHANGED Viewed

@@ -20,7 +20,7 @@ export declare const publicV1StandardRatePolicy: {
 export declare const PUBLIC_V1_FEATURES: readonly ['account', 'actions', 'analytics', 'audit', 'backlinks', 'content', 'mentions', 'page', 'research', 'sites', 'timeline'];
 export declare const PUBLIC_V1_METHODS: readonly ['DELETE', 'GET', 'PATCH', 'POST'];
 export declare const PUBLIC_V1_CREDENTIALS: readonly ['api_token', 'session'];
-export declare const PUBLIC_V1_SCOPES: readonly ['account:read', 'actions:read', 'actions:write', 'analytics:read', 'audit:read', 'content:read', 'content:write', 'page:read', 'page:write', 'research:read', 'research:write', 'sites:read', 'sites:write', 'timeline:read', 'timeline:write'];
+export declare const PUBLIC_V1_SCOPES: readonly ['account:read', 'actions:read', 'actions:write', 'analytics:read', 'audit:read', 'content:read', 'content:write', 'feedback:write', 'page:read', 'page:write', 'research:read', 'research:write', 'sites:read', 'sites:write', 'timeline:read', 'timeline:write'];
 export declare const PUBLIC_V1_ROLES: readonly ['viewer', 'member', 'admin', 'owner'];
 export declare const PUBLIC_V1_ERROR_CODES: readonly ['invalid_request', 'unauthorized', 'forbidden', 'not_found', 'site_ambiguous', 'auth_expired', 'entitlement_required', 'quota_exhausted', 'provider_unavailable', 'stale_evidence', 'conflict', 'rate_limited', 'contract_violation', 'internal_error'];
 export declare const PUBLIC_V1_ERROR_STATUS: {
@@ -47,7 +47,7 @@ export type PublicV1Role = typeof PUBLIC_V1_ROLES[number];
 export type PublicV1ErrorCode = typeof PUBLIC_V1_ERROR_CODES[number];
 export type PublicV1Visibility = 'internal' | 'public';
 export type PublicV1OwnershipRule = 'principal' | 'site' | 'team';
-export type PublicV1ResourceType = 'account.usage' | 'site.actions' | 'site.analytics' | 'site.audit' | 'site.collection' | 'site.content' | 'site.identity' | 'site.page' | 'site.research' | 'site.sitemaps' | 'site.timeline';
+export type PublicV1ResourceType = 'account.usage' | 'account.feedback' | 'site.actions' | 'site.analytics' | 'site.audit' | 'site.collection' | 'site.content' | 'site.identity' | 'site.page' | 'site.research' | 'site.sitemaps' | 'site.timeline';
 export interface PublicV1ExpectedFailure {
     _tag: 'ApiFailure';
     code: PublicV1ErrorCode;

package/dist/v1/core.js CHANGED Viewed

@@ -42,6 +42,7 @@ export const PUBLIC_V1_SCOPES = [
     'audit:read',
     'content:read',
     'content:write',
+    'feedback:write',
     'page:read',
     'page:write',
     'research:read',