@nuxtseo/protocol 0.3.0 → 0.4.0

package/dist/v1/content.js

@@ -1,341 +0,0 @@
-import { z as schema } from 'zod';
-import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1StandardRatePolicy, } from './core.js';
-export const contentBriefStatusSchema = schema.enum([
-    'queued',
-    'researching',
-    'ready',
-    'written',
-    'published',
-    'stale',
-    'failed',
-    'archived',
-]);
-export const contentBriefSiteParamsSchema = schema.strictObject({
-    siteId: schema.string().min(1),
-});
-export const contentBriefParamsSchema = schema.strictObject({
-    siteId: schema.string().min(1),
-    briefId: schema.string().min(1),
-});
-export const contentBriefListQuerySchema = schema.strictObject({
-    status: contentBriefStatusSchema.optional(),
-    limit: schema.coerce.number().int().min(1).max(100).default(25),
-    offset: schema.coerce.number().int().nonnegative().default(0),
-});
-export const contentBriefCreateBodySchema = schema.strictObject({
-    keyword: schema.string().min(1).max(200).transform(keyword => keyword.trim()),
-    targetPage: schema.url().optional(),
-    currentRank: schema.number().optional(),
-    currentImpressions: schema.number().int().optional(),
-    currentClicks: schema.number().int().optional(),
-});
-const contentBriefSerpResultShape = {
-    position: schema.number(),
-    url: schema.url(),
-    title: schema.string(),
-    domain: schema.string(),
-    snippet: schema.string().optional(),
-    wordCount: schema.number().int().nonnegative().optional(),
-};
-export const contentBriefSerpResultSchema = defineResponseObject(contentBriefSerpResultShape);
-const contentBriefPaaItemShape = {
-    question: schema.string(),
-    answer: schema.string().optional(),
-};
-export const contentBriefPaaItemSchema = defineResponseObject(contentBriefPaaItemShape);
-const contentBriefSerpSnapshotShape = {
-    fetchedAt: schema.iso.datetime(),
-    topResults: schema.array(contentBriefSerpResultSchema.producer),
-    paa: schema.array(contentBriefPaaItemSchema.producer).optional(),
-    aiOverviewPresent: schema.boolean().optional(),
-    serpFeatures: schema.array(schema.string()).optional(),
-    medianWordCount: schema.number().int().nonnegative().optional(),
-};
-export const contentBriefSerpSnapshotSchema = defineResponseObject(contentBriefSerpSnapshotShape, {
-    ...contentBriefSerpSnapshotShape,
-    topResults: schema.array(contentBriefSerpResultSchema.client),
-    paa: schema.array(contentBriefPaaItemSchema.client).optional(),
-});
-const contentBriefOutlineItemShape = {
-    level: schema.enum(['h1', 'h2', 'h3']),
-    heading: schema.string(),
-    tag: schema.enum(['intent-match', 'your-strength', 'gap', 'from-paa', 'from-aio']).optional(),
-    annotation: schema.string().optional(),
-    wordCountTarget: schema.number().int().nonnegative().optional(),
-    sourceResultUrls: schema.array(schema.url()).optional(),
-    existingCoverageExcerpt: schema.string().optional(),
-    existingCoverageUrl: schema.url().optional(),
-};
-export const contentBriefOutlineItemSchema = defineResponseObject(contentBriefOutlineItemShape);
-const contentBriefInternalLinkShape = {
-    url: schema.url(),
-    impressions: schema.number().int().optional(),
-    position: schema.number().optional(),
-    reasoning: schema.string(),
-    anchorSuggestion: schema.string().optional(),
-    excerpt: schema.string().optional(),
-};
-export const contentBriefInternalLinkSchema = defineResponseObject(contentBriefInternalLinkShape);
-const contentBriefPayloadProducerShape = {
-    targetPage: schema.url().optional(),
-    currentRank: schema.number().optional(),
-    currentImpressions: schema.number().int().optional(),
-    currentClicks: schema.number().int().optional(),
-    serp: contentBriefSerpSnapshotSchema.producer.optional(),
-    outline: schema.array(contentBriefOutlineItemSchema.producer).optional(),
-    internalLinks: schema.array(contentBriefInternalLinkSchema.producer).optional(),
-    summary: schema.string().optional(),
-    notes: schema.array(schema.string()).optional(),
-};
-export const contentBriefPayloadSchema = defineResponseObject(contentBriefPayloadProducerShape, {
-    ...contentBriefPayloadProducerShape,
-    serp: contentBriefSerpSnapshotSchema.client.optional(),
-    outline: schema.array(contentBriefOutlineItemSchema.client).optional(),
-    internalLinks: schema.array(contentBriefInternalLinkSchema.client).optional(),
-});
-const contentBriefSummaryProducerShape = {
-    id: schema.string().min(1),
-    siteId: schema.string().min(1),
-    keyword: schema.string().min(1),
-    status: contentBriefStatusSchema,
-    error: schema.string().nullable(),
-    generatedAt: schema.iso.datetime().nullable(),
-    markedPublishedAt: schema.iso.datetime().nullable(),
-    updatedAt: schema.iso.datetime().nullable(),
-};
-export const contentBriefSummarySchema = defineResponseObject(contentBriefSummaryProducerShape);
-export const contentBriefResourceSchema = defineResponseObject({
-    ...contentBriefSummaryProducerShape,
-    payload: contentBriefPayloadSchema.producer.nullable(),
-    createdAt: schema.iso.datetime().nullable(),
-    markedWrittenAt: schema.iso.datetime().nullable(),
-}, {
-    ...contentBriefSummaryProducerShape,
-    payload: contentBriefPayloadSchema.client.nullable(),
-    createdAt: schema.iso.datetime().nullable(),
-    markedWrittenAt: schema.iso.datetime().nullable(),
-});
-const contentBriefPageShape = {
-    total: schema.number().int().nonnegative(),
-    limit: schema.number().int().positive(),
-    offset: schema.number().int().nonnegative(),
-    hasMore: schema.boolean(),
-};
-const contentBriefPageSchema = defineResponseObject(contentBriefPageShape);
-export const contentBriefListDataSchema = defineResponseObject({
-    /**
-     * Deprecated alias of `rows`. Kept for one minor version, then removed.
-     */
-    briefs: schema.array(contentBriefSummarySchema.producer),
-    rows: schema.array(contentBriefSummarySchema.producer),
-    page: contentBriefPageSchema.producer,
-}, {
-    briefs: schema.array(contentBriefSummarySchema.client),
-    rows: schema.array(contentBriefSummarySchema.client).optional(),
-    page: contentBriefPageSchema.client,
-});
-export const contentBriefCreateDataSchema = defineResponseObject({
-    brief: contentBriefResourceSchema.producer,
-    created: schema.boolean(),
-}, {
-    brief: contentBriefResourceSchema.client,
-    created: schema.boolean(),
-});
-export const contentBriefListResponseSchema = defineSuccessEnvelope(contentBriefListDataSchema);
-export const contentBriefShowResponseSchema = defineSuccessEnvelope(contentBriefResourceSchema);
-export const contentBriefCreateResponseSchema = defineSuccessEnvelope(contentBriefCreateDataSchema);
-const readErrors = [
-    'invalid_request',
-    'unauthorized',
-    'auth_expired',
-    'forbidden',
-    'not_found',
-    'rate_limited',
-    'contract_violation',
-    'internal_error',
-];
-export const contentBriefListOperation = defineOperation({
-    id: 'content.briefs.list',
-    method: 'GET',
-    path: '/api/v1/sites/{siteId}/content/briefs',
-    visibility: 'public',
-    semantics: {
-        kind: 'query',
-        sideEffects: 'none',
-        retry: 'idempotent',
-        readConsistency: 'primary',
-    },
-    auth: {
-        credentials: ['session', 'api_token'],
-        scopes: ['content:read'],
-        minimumRole: 'viewer',
-        ownership: 'site',
-    },
-    request: {
-        params: contentBriefSiteParamsSchema,
-        query: contentBriefListQuerySchema,
-        headers: null,
-        body: null,
-    },
-    responses: { 200: contentBriefListResponseSchema },
-    errors: readErrors,
-    errorResponse: publicV1ErrorEnvelope,
-    resources: { reads: [{ type: 'site.content', idFrom: 'params.siteId' }], changes: [] },
-    policy: { rate: publicV1StandardRatePolicy, idempotency: { _tag: 'none' }, entitlement: null, meter: null },
-    lifecycle: { introduced: '1.0.0' },
-    docs: {
-        summary: 'List Content Briefs',
-        description: 'Lists one page of Content Brief summaries owned by a NuxtSEO Site.',
-        tags: ['Content'],
-        examples: [{
-                request: { params: { siteId: 'site_01JXYZ' }, query: { limit: 25, offset: 0 } },
-                response: {
-                    status: 200,
-                    body: {
-                        data: {
-                            briefs: [{
-                                    id: 'brief_01JXYZ',
-                                    siteId: 'site_01JXYZ',
-                                    keyword: 'nuxt seo',
-                                    status: 'ready',
-                                    error: null,
-                                    generatedAt: '2026-08-10T00:00:00.000Z',
-                                    markedPublishedAt: null,
-                                    updatedAt: '2026-08-10T00:00:00.000Z',
-                                }],
-                            rows: [{
-                                    id: 'brief_01JXYZ',
-                                    siteId: 'site_01JXYZ',
-                                    keyword: 'nuxt seo',
-                                    status: 'ready',
-                                    error: null,
-                                    generatedAt: '2026-08-10T00:00:00.000Z',
-                                    markedPublishedAt: null,
-                                    updatedAt: '2026-08-10T00:00:00.000Z',
-                                }],
-                            page: { total: 1, limit: 25, offset: 0, hasMore: false },
-                        },
-                        meta: { requestId: 'req_01JXYZ', version: '1.0' },
-                    },
-                },
-            }],
-    },
-});
-const exampleBrief = {
-    id: 'brief_01JXYZ',
-    siteId: 'site_01JXYZ',
-    keyword: 'nuxt seo',
-    status: 'ready',
-    error: null,
-    generatedAt: '2026-08-10T00:00:00.000Z',
-    markedPublishedAt: null,
-    updatedAt: '2026-08-10T00:00:00.000Z',
-    createdAt: '2026-08-10T00:00:00.000Z',
-    markedWrittenAt: null,
-    payload: {
-        targetPage: 'https://example.com/guide',
-        outline: [{ level: 'h1', heading: 'Nuxt SEO' }],
-        internalLinks: [],
-    },
-};
-export const contentBriefShowOperation = defineOperation({
-    id: 'content.briefs.show',
-    method: 'GET',
-    path: '/api/v1/sites/{siteId}/content/briefs/{briefId}',
-    visibility: 'public',
-    semantics: {
-        kind: 'query',
-        sideEffects: 'none',
-        retry: 'idempotent',
-        readConsistency: 'primary',
-    },
-    auth: {
-        credentials: ['session', 'api_token'],
-        scopes: ['content:read'],
-        minimumRole: 'viewer',
-        ownership: 'site',
-    },
-    request: { params: contentBriefParamsSchema, query: null, headers: null, body: null },
-    responses: { 200: contentBriefShowResponseSchema },
-    errors: readErrors,
-    errorResponse: publicV1ErrorEnvelope,
-    resources: { reads: [{ type: 'site.content', idFrom: 'params.siteId' }], changes: [] },
-    policy: { rate: publicV1StandardRatePolicy, idempotency: { _tag: 'none' }, entitlement: null, meter: null },
-    lifecycle: { introduced: '1.0.0' },
-    docs: {
-        summary: 'Show a Content Brief',
-        description: 'Returns one Content Brief with its grounded SERP, outline, and internal-link evidence.',
-        tags: ['Content'],
-        examples: [{
-                request: { params: { siteId: 'site_01JXYZ', briefId: 'brief_01JXYZ' } },
-                response: {
-                    status: 200,
-                    body: { data: exampleBrief, meta: { requestId: 'req_01JXYZ', version: '1.0' } },
-                },
-            }],
-    },
-});
-export const contentBriefCreateOperation = defineOperation({
-    id: 'content.briefs.create',
-    method: 'POST',
-    path: '/api/v1/sites/{siteId}/content/briefs',
-    visibility: 'public',
-    semantics: {
-        kind: 'mutation',
-        sideEffects: 'state',
-        retry: 'never',
-        readConsistency: null,
-    },
-    auth: {
-        credentials: ['session', 'api_token'],
-        scopes: ['content:write'],
-        minimumRole: 'member',
-        ownership: 'site',
-    },
-    request: {
-        params: contentBriefSiteParamsSchema,
-        query: null,
-        headers: null,
-        body: contentBriefCreateBodySchema,
-    },
-    responses: { 200: contentBriefCreateResponseSchema },
-    errors: [
-        ...readErrors,
-        'entitlement_required',
-        'conflict',
-        'quota_exhausted',
-    ],
-    errorResponse: publicV1ErrorEnvelope,
-    resources: {
-        reads: [{ type: 'site.content', idFrom: 'params.siteId' }],
-        changes: [{ type: 'site.content', idFrom: 'params.siteId' }],
-    },
-    policy: { rate: publicV1StandardRatePolicy, idempotency: { _tag: 'none' }, entitlement: 'pro', meter: null },
-    lifecycle: { introduced: '1.0.0' },
-    docs: {
-        summary: 'Create a Content Brief',
-        description: 'Creates or returns the existing Site-owned Content Brief for a canonical target keyword.',
-        tags: ['Content'],
-        examples: [{
-                request: {
-                    params: { siteId: 'site_01JXYZ' },
-                    body: { keyword: 'nuxt seo', targetPage: 'https://example.com/guide' },
-                },
-                response: {
-                    status: 200,
-                    body: {
-                        data: { brief: exampleBrief, created: true },
-                        meta: { requestId: 'req_01JXYZ', version: '1.0' },
-                    },
-                },
-            }],
-    },
-});
-export const contentV1Registry = defineRegistry({
-    feature: 'content',
-    operations: {
-        listBriefs: contentBriefListOperation,
-        showBrief: contentBriefShowOperation,
-        createBrief: contentBriefCreateOperation,
-    },
-});