@nuxtseo/protocol 0.5.7 → 0.5.8

package/dist/v1/sitemaps.js

@@ -1,7 +1,23 @@
 import { gscdumpSitemapsResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, } from '@gscdump/contracts';
+import { sitemapEvidenceV1Schemas, sitemapInspectQueryV1Schema, sitemapSubmissionStateV1Schemas } from '@gscdump/contracts/v1/http';
 import { z as schema } from 'zod';
 import { defineOperation, defineRegistry, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1StandardRatePolicy, } from './core.js';
 export const siteSitemapParamsSchema = schema.strictObject({ siteId: schema.string().min(1) });
+// Expose the grant's role without exposing the account owner's identity.
+const publicGrantHolder = schema.strictObject({ _tag: schema.enum(['caller', 'site-owner']) });
+const publicSubmissionStates = sitemapSubmissionStateV1Schemas.producer.options.map(state => 'grantHolder' in state.shape ? state.extend({ grantHolder: publicGrantHolder }).strict() : state.strict());
+const publicSubmissionClientStates = sitemapSubmissionStateV1Schemas.client.options.map(state => 'grantHolder' in state.shape ? state.extend({ grantHolder: publicGrantHolder.loose() }).loose() : state.loose());
+export const siteSitemapSubmissionDataSchema = schema.strictObject({
+    searchEngine: schema.literal('google'),
+    gscPropertyUrl: schema.string().min(1),
+    callerCanAct: schema.boolean(),
+    state: schema.union([...publicSubmissionStates, schema.strictObject({ _tag: schema.literal('unknown') })]),
+});
+export const siteSitemapSubmissionResponseSchema = defineSuccessEnvelope({
+    producer: siteSitemapSubmissionDataSchema,
+    client: siteSitemapSubmissionDataSchema.extend({ state: schema.union([...publicSubmissionClientStates, schema.object({ _tag: schema.literal('unknown') }).loose()]) }).loose(),
+});
+export const siteSitemapEvidenceResponseSchema = defineSuccessEnvelope(sitemapEvidenceV1Schemas);
 const [submitSitemapSchema, deleteSitemapSchema] = partnerSitemapActionSchema.options;
 export const siteSitemapActionBodySchema = schema.discriminatedUnion('action', [
     submitSitemapSchema,
@@ -190,10 +206,39 @@ export const siteSitemapActionCreateOperation = defineOperation({
             }],
     },
 });
+export const siteSitemapSubmissionReadOperation = defineOperation({
+    ...siteSitemapsListOperation,
+    id: 'sites.sitemaps.submission.read',
+    path: '/api/v1/sites/{siteId}/sitemaps/submission',
+    responses: { 200: siteSitemapSubmissionResponseSchema },
+    docs: {
+        summary: 'Read Site Sitemap submission',
+        description: 'Returns site-level Google Sitemap submission readiness. It does not prove submission of an arbitrary Sitemap URL.',
+        tags: ['Sites', 'Sitemaps'],
+        examples: [{ request: { params: { siteId: 'site_01JXYZ' } }, response: { status: 200, body: { data: { searchEngine: 'google', gscPropertyUrl: 'sc-domain:example.com', callerCanAct: false, state: { _tag: 'not-checked' } }, meta: { requestId: 'req_01JXYZ', version: '1.0' } } } }],
+    },
+});
+export const siteSitemapInspectOperation = defineOperation({
+    ...siteSitemapsListOperation,
+    id: 'sites.sitemaps.inspect',
+    path: '/api/v1/sites/{siteId}/sitemaps/inspect',
+    semantics: { kind: 'query', sideEffects: 'none', retry: 'idempotent', readConsistency: 'primary' },
+    request: { params: siteSitemapParamsSchema, query: sitemapInspectQueryV1Schema, headers: null, body: null },
+    responses: { 200: siteSitemapEvidenceResponseSchema },
+    errors: [...readErrors, 'entitlement_required'],
+    docs: {
+        summary: 'Inspect one Site Sitemap',
+        description: 'Reads exact Sitemap listing evidence from Google live or Bing stored data. Every successful read carries its capture time.',
+        tags: ['Sites', 'Sitemaps'],
+        examples: [{ request: { params: { siteId: 'site_01JXYZ' }, query: { url: 'https://example.com/sitemap.xml', searchEngine: 'google' } }, response: { status: 200, body: { data: { searchEngine: 'google', sitemapUrl: 'https://example.com/sitemap.xml', capture: { _tag: 'captured', source: 'live', capturedAt: '2026-10-08T00:00:00Z' }, state: { _tag: 'missing' } }, meta: { requestId: 'req_01JXYZ', version: '1.0' } } } }],
+    },
+});
 export const sitemapsV1Registry = defineRegistry({
     feature: 'sites',
     operations: {
         list: siteSitemapsListOperation,
+        readSubmission: siteSitemapSubmissionReadOperation,
+        inspect: siteSitemapInspectOperation,
         listUrls: siteSitemapUrlsListOperation,
         createAction: siteSitemapActionCreateOperation,
     },