@nuxtseo/protocol 0.1.4 → 0.1.5

package/dist/v1/gsc.js

@@ -15,6 +15,31 @@ export const searchAnalyticsViewSchema = schema.enum([
     'analysis',
 ]);
 const periodSchema = schema.enum(['7d', '28d', '3m', '6m', '12m']);
+/**
+ * Legacy response discriminator alias. This operation shipped in 1.0.0 with
+ * its response objects discriminating on `type`; v1 clients generated from
+ * that contract still key on it. Producers keep emitting `type` alongside the
+ * canonical `view` for one deprecation window instead of breaking them
+ * implicitly within the same major version.
+ */
+function legacyViewDiscriminator(view) {
+    return schema.literal(view).default(view);
+}
+/**
+ * Accept envelopes keyed by either spelling: a payload carrying only the
+ * legacy `type` gains the canonical `view` before the discriminated union
+ * parses it.
+ */
+function acceptLegacyViewDiscriminator(union) {
+    return schema.preprocess((value) => {
+        if (typeof value !== 'object' || value === null || Array.isArray(value))
+            return value;
+        const candidate = value;
+        if (!('view' in candidate) && typeof candidate.type === 'string')
+            return { ...candidate, view: candidate.type };
+        return value;
+    }, union);
+}
 const pageUrlSchema = schema.string().refine(value => value.startsWith('/') || URL.canParse(value), 'Expected an absolute URL or a site-relative path starting with /.');
 export const searchAnalyticsQuerySchema = schema.strictObject({
     view: searchAnalyticsViewSchema,
@@ -92,7 +117,8 @@ const deviceRowSchema = defineResponseObject({
 function breakdownSchema(view, row) {
     return defineResponseObject({
         site: schema.string().min(1),
-        type: schema.literal(view),
+        view: schema.literal(view),
+        type: legacyViewDiscriminator(view),
         period: periodSchema,
         total: schema.number().int().nonnegative(),
         totals: totalsSchema.producer.nullable(),
@@ -102,7 +128,7 @@ function breakdownSchema(view, row) {
         rows: schema.array(row.producer),
     }, {
         site: schema.string().min(1),
-        type: schema.literal(view),
+        view: schema.literal(view),
         period: periodSchema,
         total: schema.number().int().nonnegative(),
         totals: totalsSchema.client.nullable(),
@@ -125,14 +151,15 @@ const dailyRowSchema = defineResponseObject({
 });
 const timeseriesDataSchema = defineResponseObject({
     site: schema.string().min(1),
-    type: schema.literal('timeseries'),
+    view: schema.literal('timeseries'),
+    type: legacyViewDiscriminator('timeseries'),
     period: periodSchema,
     totals: totalsSchema.producer.nullable(),
     prevTotals: totalsSchema.producer.nullable(),
     daily: schema.array(dailyRowSchema.producer),
 }, {
     site: schema.string().min(1),
-    type: schema.literal('timeseries'),
+    view: schema.literal('timeseries'),
     period: periodSchema,
     totals: totalsSchema.client.nullable(),
     prevTotals: totalsSchema.client.nullable(),
@@ -149,14 +176,15 @@ const pageDetailRowSchema = defineResponseObject({
 });
 const pageDetailDataSchema = defineResponseObject({
     site: schema.string().min(1),
-    type: schema.literal('page-detail'),
+    view: schema.literal('page-detail'),
+    type: legacyViewDiscriminator('page-detail'),
     pageUrl: pageUrlSchema,
     period: periodSchema,
     totals: totalsSchema.producer.nullable(),
     rows: schema.array(pageDetailRowSchema.producer),
 }, {
     site: schema.string().min(1),
-    type: schema.literal('page-detail'),
+    view: schema.literal('page-detail'),
     pageUrl: pageUrlSchema,
     period: periodSchema,
     totals: totalsSchema.client.nullable(),
@@ -173,14 +201,15 @@ const keywordDetailRowSchema = defineResponseObject({
 });
 const keywordDetailDataSchema = defineResponseObject({
     site: schema.string().min(1),
-    type: schema.literal('keyword-detail'),
+    view: schema.literal('keyword-detail'),
+    type: legacyViewDiscriminator('keyword-detail'),
     keyword: schema.string().min(1),
     period: periodSchema,
     totals: totalsSchema.producer.nullable(),
     rows: schema.array(keywordDetailRowSchema.producer),
 }, {
     site: schema.string().min(1),
-    type: schema.literal('keyword-detail'),
+    view: schema.literal('keyword-detail'),
     keyword: schema.string().min(1),
     period: periodSchema,
     totals: totalsSchema.client.nullable(),
@@ -205,7 +234,8 @@ const analysisRowSchema = defineResponseObject({
 });
 const analysisDataSchema = defineResponseObject({
     site: schema.string().min(1),
-    type: schema.literal('analysis'),
+    view: schema.literal('analysis'),
+    type: legacyViewDiscriminator('analysis'),
     preset: gscdumpAnalysisPresetSchema,
     description: schema.string().min(1),
     criteria: schema.record(schema.string(), schema.union([schema.string(), schema.number(), schema.null()])),
@@ -215,7 +245,7 @@ const analysisDataSchema = defineResponseObject({
     rows: schema.array(analysisRowSchema.producer),
 }, {
     site: schema.string().min(1),
-    type: schema.literal('analysis'),
+    view: schema.literal('analysis'),
     preset: gscdumpAnalysisPresetSchema,
     description: schema.string().min(1),
     criteria: schema.record(schema.string(), schema.union([schema.string(), schema.number(), schema.null()])),
@@ -225,7 +255,7 @@ const analysisDataSchema = defineResponseObject({
     rows: schema.array(analysisRowSchema.client),
 });
 export const searchAnalyticsDataSchema = {
-    producer: schema.discriminatedUnion('type', [
+    producer: schema.discriminatedUnion('view', [
         pagesDataSchema.producer,
         keywordsDataSchema.producer,
         countriesDataSchema.producer,
@@ -235,7 +265,7 @@ export const searchAnalyticsDataSchema = {
         keywordDetailDataSchema.producer,
         analysisDataSchema.producer,
     ]),
-    client: schema.discriminatedUnion('type', [
+    client: acceptLegacyViewDiscriminator(schema.discriminatedUnion('view', [
         pagesDataSchema.client,
         keywordsDataSchema.client,
         countriesDataSchema.client,
@@ -244,7 +274,7 @@ export const searchAnalyticsDataSchema = {
         pageDetailDataSchema.client,
         keywordDetailDataSchema.client,
         analysisDataSchema.client,
-    ]),
+    ])),
 };
 export const searchAnalyticsResponseSchema = defineSuccessEnvelope(searchAnalyticsDataSchema);
 export const searchStatusDataSchema = {
@@ -480,7 +510,7 @@ export const searchAnalyticsQueryOperation = defineOperation({
         tags: ['Sites', 'Search'],
         examples: [{
                 request: { params: { siteId: 'site_01JXYZ' }, query: { view: 'keywords' } },
-                response: { status: 200, body: { data: { site: 'https://example.com', type: 'keywords', period: '28d', total: 1, totals: { clicks: 12, impressions: 100, ctr: 0.12, position: 4 }, totalsScope: 'full upstream query population', representedTotals: { clicks: 12, impressions: 100 }, representedTotalsScope: 'returned rows', rows: [{ keyword: 'nuxt seo', clicks: 12, impressions: 100, ctr: 0.12, pos: 4, topPage: 'https://example.com/docs', change: 2 }] }, meta: { requestId: 'req_01JXYZ', version: '1.0' } } },
+                response: { status: 200, body: { data: { site: 'https://example.com', view: 'keywords', period: '28d', total: 1, totals: { clicks: 12, impressions: 100, ctr: 0.12, position: 4 }, totalsScope: 'full upstream query population', representedTotals: { clicks: 12, impressions: 100 }, representedTotalsScope: 'returned rows', rows: [{ keyword: 'nuxt seo', clicks: 12, impressions: 100, ctr: 0.12, pos: 4, topPage: 'https://example.com/docs', change: 2 }] }, meta: { requestId: 'req_01JXYZ', version: '1.0' } } },
             }],
     },
 });

package/dist/v1/pages.js

@@ -1,11 +1,11 @@
 import { z as schema } from 'zod';
-import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1StandardRatePolicy, } from './core.js';
+import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1BooleanFlag, publicV1ErrorEnvelope, publicV1StandardRatePolicy, } from './core.js';
 export const pageSiteParamsSchema = schema.strictObject({
     siteId: schema.string().min(1),
 });
 export const pageInspectQuerySchema = schema.strictObject({
     url: schema.string().url(),
-    includeResolved: schema.enum(['0', '1', 'true', 'false']).default('0').transform(value => value === '1' || value === 'true'),
+    includeResolved: publicV1BooleanFlag(false),
     limit: schema.coerce.number().int().min(1).max(200).default(100),
     offset: schema.coerce.number().int().min(0).default(0),
 });