@nuxtseo/protocol 0.1.0

package/dist/v1/sitemaps.js

@@ -0,0 +1,199 @@
+import { gscdumpSitemapsResponseSchema, gscdumpSitemapUrlsQuerySchema, gscdumpSitemapUrlsResponseSchema, partnerSitemapActionResponseSchema, partnerSitemapActionSchema, } from '@gscdump/contracts';
+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) });
+const [submitSitemapSchema, deleteSitemapSchema] = partnerSitemapActionSchema.options;
+export const siteSitemapActionBodySchema = schema.discriminatedUnion('action', [
+    submitSitemapSchema,
+    deleteSitemapSchema,
+]);
+const submittedOrDeletedSitemapSchema = partnerSitemapActionResponseSchema.options[0];
+export const siteSitemapsResponseSchema = defineSuccessEnvelope({
+    producer: gscdumpSitemapsResponseSchema.strict(),
+    client: gscdumpSitemapsResponseSchema.loose(),
+});
+export const siteSitemapUrlsResponseSchema = defineSuccessEnvelope({
+    producer: gscdumpSitemapUrlsResponseSchema.strict(),
+    client: gscdumpSitemapUrlsResponseSchema.loose(),
+});
+export const siteSitemapActionResponseSchema = defineSuccessEnvelope({
+    producer: submittedOrDeletedSitemapSchema.strict(),
+    client: submittedOrDeletedSitemapSchema.loose(),
+});
+const readErrors = [
+    'invalid_request',
+    'unauthorized',
+    'auth_expired',
+    'forbidden',
+    'not_found',
+    'rate_limited',
+    'provider_unavailable',
+    'contract_violation',
+    'internal_error',
+];
+export const siteSitemapsListOperation = defineOperation({
+    id: 'sites.sitemaps.list',
+    method: 'GET',
+    path: '/api/v1/sites/{siteId}/sitemaps',
+    visibility: 'public',
+    semantics: {
+        kind: 'query',
+        sideEffects: 'none',
+        retry: 'idempotent',
+        readConsistency: 'primary',
+    },
+    auth: {
+        credentials: ['session', 'api_token'],
+        scopes: ['sites:read'],
+        minimumRole: 'viewer',
+        ownership: 'site',
+    },
+    request: { params: siteSitemapParamsSchema, query: null, headers: null, body: null },
+    responses: { 200: siteSitemapsResponseSchema },
+    errors: readErrors,
+    errorResponse: publicV1ErrorEnvelope,
+    resources: { reads: [{ type: 'site.sitemaps', idFrom: 'params.siteId' }], changes: [] },
+    policy: { rate: publicV1StandardRatePolicy, idempotency: { _tag: 'none' }, entitlement: null, meter: null },
+    lifecycle: { introduced: '1.0.0' },
+    docs: {
+        summary: 'List Site sitemaps',
+        description: 'Returns the Search Console sitemap snapshot and its upstream generation for a NuxtSEO Site.',
+        tags: ['Sites', 'Sitemaps'],
+        examples: [{
+                request: { params: { siteId: 'site_01JXYZ' } },
+                response: {
+                    status: 200,
+                    body: {
+                        data: {
+                            sitemaps: [],
+                            history: [],
+                            perSitemapHistory: {},
+                            generation: null,
+                            meta: {
+                                siteUrl: 'sc-domain:example.com',
+                                gscPropertyUrl: 'sc-domain:example.com',
+                                syncStatus: 'synced',
+                                sitemapScope: { excludedCount: 0, duplicateCount: 0 },
+                            },
+                        },
+                        meta: { requestId: 'req_01JXYZ', version: '1.0' },
+                    },
+                },
+            }],
+    },
+});
+export const siteSitemapUrlsListOperation = defineOperation({
+    id: 'sites.sitemaps.urls.list',
+    method: 'GET',
+    path: '/api/v1/sites/{siteId}/sitemaps/urls',
+    visibility: 'public',
+    semantics: {
+        kind: 'query',
+        sideEffects: 'none',
+        retry: 'idempotent',
+        readConsistency: 'primary',
+    },
+    auth: {
+        credentials: ['session', 'api_token'],
+        scopes: ['sites:read'],
+        minimumRole: 'viewer',
+        ownership: 'site',
+    },
+    request: {
+        params: siteSitemapParamsSchema,
+        query: gscdumpSitemapUrlsQuerySchema,
+        headers: null,
+        body: null,
+    },
+    responses: { 200: siteSitemapUrlsResponseSchema },
+    errors: readErrors,
+    errorResponse: publicV1ErrorEnvelope,
+    resources: { reads: [{ type: 'site.sitemaps', idFrom: 'params.siteId' }], changes: [] },
+    policy: { rate: publicV1StandardRatePolicy, idempotency: { _tag: 'none' }, entitlement: null, meter: null },
+    lifecycle: { introduced: '1.0.0' },
+    docs: {
+        summary: 'List Site sitemap URLs',
+        description: 'Returns one cursor page of sitemap membership pinned to an exact upstream generation.',
+        tags: ['Sites', 'Sitemaps'],
+        examples: [{
+                request: { params: { siteId: 'site_01JXYZ' }, query: { limit: 500 } },
+                response: {
+                    status: 200,
+                    body: {
+                        data: {
+                            generation: {
+                                id: 'generation_01JXYZ',
+                                observedAt: 1786320000000,
+                                publishedAt: 1786320000100,
+                                completeness: { _tag: 'complete' },
+                                membershipHistoryAvailableFrom: 1786320000000,
+                                legacyImport: { _tag: 'none' },
+                            },
+                            items: [],
+                            page: { nextCursor: null, limit: 500 },
+                        },
+                        meta: { requestId: 'req_01JXYZ', version: '1.0' },
+                    },
+                },
+            }],
+    },
+});
+export const siteSitemapActionCreateOperation = defineOperation({
+    id: 'sites.sitemaps.action.create',
+    method: 'POST',
+    path: '/api/v1/sites/{siteId}/sitemaps/actions',
+    visibility: 'public',
+    semantics: {
+        kind: 'mutation',
+        sideEffects: 'state',
+        retry: 'never',
+        readConsistency: null,
+    },
+    auth: {
+        credentials: ['session', 'api_token'],
+        scopes: ['sites:write'],
+        minimumRole: 'member',
+        ownership: 'site',
+    },
+    request: { params: siteSitemapParamsSchema, query: null, headers: null, body: siteSitemapActionBodySchema },
+    responses: { 200: siteSitemapActionResponseSchema },
+    errors: readErrors,
+    errorResponse: publicV1ErrorEnvelope,
+    resources: {
+        reads: [{ type: 'site.sitemaps', idFrom: 'params.siteId' }],
+        changes: [{ type: 'site.sitemaps', idFrom: 'params.siteId' }],
+    },
+    policy: { rate: publicV1StandardRatePolicy, idempotency: { _tag: 'none' }, entitlement: null, meter: null },
+    lifecycle: { introduced: '1.0.0' },
+    docs: {
+        summary: 'Submit or delete a Site sitemap',
+        description: 'Submits or deletes one sitemap through the stored Search Console credential bound to the NuxtSEO Site.',
+        tags: ['Sites', 'Sitemaps'],
+        examples: [{
+                request: {
+                    params: { siteId: 'site_01JXYZ' },
+                    body: { action: 'submit', sitemapUrl: 'https://example.com/sitemap.xml' },
+                },
+                response: {
+                    status: 200,
+                    body: {
+                        data: {
+                            success: true,
+                            action: 'submitted',
+                            sitemapUrl: 'https://example.com/sitemap.xml',
+                            sitemapCount: 1,
+                        },
+                        meta: { requestId: 'req_01JXYZ', version: '1.0' },
+                    },
+                },
+            }],
+    },
+});
+export const sitemapsV1Registry = defineRegistry({
+    feature: 'sites',
+    operations: {
+        list: siteSitemapsListOperation,
+        listUrls: siteSitemapUrlsListOperation,
+        createAction: siteSitemapActionCreateOperation,
+    },
+});