@nuxtseo/protocol 0.2.1 → 0.3.0

package/dist/v1/research.d.ts

@@ -599,7 +599,19 @@ declare const keywordResearchDataSchema: import("./core.js").CompatibleResponseS
         maxDifficulty: z.ZodNumber;
         intent: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>;
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     readonly message: z.ZodOptional<z.ZodString>;
+    /**
+     * A concrete next argument to try, when `message` names a fixable argument.
+     */
     readonly tip: z.ZodOptional<z.ZodString>;
     readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         message: z.ZodString;
@@ -667,7 +679,19 @@ declare const keywordResearchDataSchema: import("./core.js").CompatibleResponseS
         maxDifficulty: z.ZodNumber;
         intent: z.ZodOptional<z.ZodString>;
     }, z.core.$loose>;
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     readonly message: z.ZodOptional<z.ZodString>;
+    /**
+     * A concrete next argument to try, when `message` names a fixable argument.
+     */
     readonly tip: z.ZodOptional<z.ZodString>;
     readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         message: z.ZodString;
@@ -737,7 +761,19 @@ export declare const keywordResearchResponseSchema: import("./core.js").Compatib
             maxDifficulty: z.ZodNumber;
             intent: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>;
+        /**
+         * Why a result set is empty, in one sentence for a person.
+         *
+         * The provider answers 200 with an empty list both when the argument was
+         * refused and when the argument was accepted but matched nothing. `message`
+         * is the only field that tells the two apart, so a caller that reads the list
+         * alone will misread a refusal as an absence of demand. Present only when the
+         * list is empty for a reason worth naming.
+         */
         readonly message: z.ZodOptional<z.ZodString>;
+        /**
+         * A concrete next argument to try, when `message` names a fixable argument.
+         */
         readonly tip: z.ZodOptional<z.ZodString>;
         readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             message: z.ZodString;
@@ -811,7 +847,19 @@ export declare const keywordResearchResponseSchema: import("./core.js").Compatib
             maxDifficulty: z.ZodNumber;
             intent: z.ZodOptional<z.ZodString>;
         }, z.core.$loose>;
+        /**
+         * Why a result set is empty, in one sentence for a person.
+         *
+         * The provider answers 200 with an empty list both when the argument was
+         * refused and when the argument was accepted but matched nothing. `message`
+         * is the only field that tells the two apart, so a caller that reads the list
+         * alone will misread a refusal as an absence of demand. Present only when the
+         * list is empty for a reason worth naming.
+         */
         readonly message: z.ZodOptional<z.ZodString>;
+        /**
+         * A concrete next argument to try, when `message` names a fixable argument.
+         */
         readonly tip: z.ZodOptional<z.ZodString>;
         readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             message: z.ZodString;
@@ -982,6 +1030,15 @@ declare const rankingsResearchDataSchema: import("./core.js").CompatibleResponse
         min: z.ZodNumber;
         max: z.ZodNumber;
     }, z.core.$strict>>;
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     readonly message: z.ZodOptional<z.ZodString>;
     readonly cached: z.ZodBoolean;
 }, z.core.$strip>, z.ZodObject<{
@@ -1017,6 +1074,15 @@ declare const rankingsResearchDataSchema: import("./core.js").CompatibleResponse
         min: z.ZodNumber;
         max: z.ZodNumber;
     }, z.core.$loose>>;
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     readonly message: z.ZodOptional<z.ZodString>;
     readonly cached: z.ZodBoolean;
 }, z.core.$strip>>;
@@ -1054,6 +1120,15 @@ export declare const rankingsResearchResponseSchema: import("./core.js").Compati
             min: z.ZodNumber;
             max: z.ZodNumber;
         }, z.core.$strict>>;
+        /**
+         * Why a result set is empty, in one sentence for a person.
+         *
+         * The provider answers 200 with an empty list both when the argument was
+         * refused and when the argument was accepted but matched nothing. `message`
+         * is the only field that tells the two apart, so a caller that reads the list
+         * alone will misread a refusal as an absence of demand. Present only when the
+         * list is empty for a reason worth naming.
+         */
         readonly message: z.ZodOptional<z.ZodString>;
         readonly cached: z.ZodBoolean;
     }, z.core.$strip>;
@@ -1095,6 +1170,15 @@ export declare const rankingsResearchResponseSchema: import("./core.js").Compati
             min: z.ZodNumber;
             max: z.ZodNumber;
         }, z.core.$loose>>;
+        /**
+         * Why a result set is empty, in one sentence for a person.
+         *
+         * The provider answers 200 with an empty list both when the argument was
+         * refused and when the argument was accepted but matched nothing. `message`
+         * is the only field that tells the two apart, so a caller that reads the list
+         * alone will misread a refusal as an absence of demand. Present only when the
+         * list is empty for a reason worth naming.
+         */
         readonly message: z.ZodOptional<z.ZodString>;
         readonly cached: z.ZodBoolean;
     }, z.core.$strip>;
@@ -1504,7 +1588,19 @@ export declare const keywordResearchOperation: {
                     maxDifficulty: z.ZodNumber;
                     intent: z.ZodOptional<z.ZodString>;
                 }, z.core.$strict>;
+                /**
+                 * Why a result set is empty, in one sentence for a person.
+                 *
+                 * The provider answers 200 with an empty list both when the argument was
+                 * refused and when the argument was accepted but matched nothing. `message`
+                 * is the only field that tells the two apart, so a caller that reads the list
+                 * alone will misread a refusal as an absence of demand. Present only when the
+                 * list is empty for a reason worth naming.
+                 */
                 readonly message: z.ZodOptional<z.ZodString>;
+                /**
+                 * A concrete next argument to try, when `message` names a fixable argument.
+                 */
                 readonly tip: z.ZodOptional<z.ZodString>;
                 readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
                     message: z.ZodString;
@@ -1578,7 +1674,19 @@ export declare const keywordResearchOperation: {
                     maxDifficulty: z.ZodNumber;
                     intent: z.ZodOptional<z.ZodString>;
                 }, z.core.$loose>;
+                /**
+                 * Why a result set is empty, in one sentence for a person.
+                 *
+                 * The provider answers 200 with an empty list both when the argument was
+                 * refused and when the argument was accepted but matched nothing. `message`
+                 * is the only field that tells the two apart, so a caller that reads the list
+                 * alone will misread a refusal as an absence of demand. Present only when the
+                 * list is empty for a reason worth naming.
+                 */
                 readonly message: z.ZodOptional<z.ZodString>;
+                /**
+                 * A concrete next argument to try, when `message` names a fixable argument.
+                 */
                 readonly tip: z.ZodOptional<z.ZodString>;
                 readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
                     message: z.ZodString;
@@ -1998,6 +2106,15 @@ export declare const rankingsResearchOperation: {
                     min: z.ZodNumber;
                     max: z.ZodNumber;
                 }, z.core.$strict>>;
+                /**
+                 * Why a result set is empty, in one sentence for a person.
+                 *
+                 * The provider answers 200 with an empty list both when the argument was
+                 * refused and when the argument was accepted but matched nothing. `message`
+                 * is the only field that tells the two apart, so a caller that reads the list
+                 * alone will misread a refusal as an absence of demand. Present only when the
+                 * list is empty for a reason worth naming.
+                 */
                 readonly message: z.ZodOptional<z.ZodString>;
                 readonly cached: z.ZodBoolean;
             }, z.core.$strip>;
@@ -2039,6 +2156,15 @@ export declare const rankingsResearchOperation: {
                     min: z.ZodNumber;
                     max: z.ZodNumber;
                 }, z.core.$loose>>;
+                /**
+                 * Why a result set is empty, in one sentence for a person.
+                 *
+                 * The provider answers 200 with an empty list both when the argument was
+                 * refused and when the argument was accepted but matched nothing. `message`
+                 * is the only field that tells the two apart, so a caller that reads the list
+                 * alone will misread a refusal as an absence of demand. Present only when the
+                 * list is empty for a reason worth naming.
+                 */
                 readonly message: z.ZodOptional<z.ZodString>;
                 readonly cached: z.ZodBoolean;
             }, z.core.$strip>;
@@ -3392,7 +3518,19 @@ export declare const researchV1Registry: import("./core.js").PublicV1Registry<{
                         maxDifficulty: z.ZodNumber;
                         intent: z.ZodOptional<z.ZodString>;
                     }, z.core.$strict>;
+                    /**
+                     * Why a result set is empty, in one sentence for a person.
+                     *
+                     * The provider answers 200 with an empty list both when the argument was
+                     * refused and when the argument was accepted but matched nothing. `message`
+                     * is the only field that tells the two apart, so a caller that reads the list
+                     * alone will misread a refusal as an absence of demand. Present only when the
+                     * list is empty for a reason worth naming.
+                     */
                     readonly message: z.ZodOptional<z.ZodString>;
+                    /**
+                     * A concrete next argument to try, when `message` names a fixable argument.
+                     */
                     readonly tip: z.ZodOptional<z.ZodString>;
                     readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
                         message: z.ZodString;
@@ -3466,7 +3604,19 @@ export declare const researchV1Registry: import("./core.js").PublicV1Registry<{
                         maxDifficulty: z.ZodNumber;
                         intent: z.ZodOptional<z.ZodString>;
                     }, z.core.$loose>;
+                    /**
+                     * Why a result set is empty, in one sentence for a person.
+                     *
+                     * The provider answers 200 with an empty list both when the argument was
+                     * refused and when the argument was accepted but matched nothing. `message`
+                     * is the only field that tells the two apart, so a caller that reads the list
+                     * alone will misread a refusal as an absence of demand. Present only when the
+                     * list is empty for a reason worth naming.
+                     */
                     readonly message: z.ZodOptional<z.ZodString>;
+                    /**
+                     * A concrete next argument to try, when `message` names a fixable argument.
+                     */
                     readonly tip: z.ZodOptional<z.ZodString>;
                     readonly serpFallback: z.ZodOptional<z.ZodNullable<z.ZodObject<{
                         message: z.ZodString;
@@ -3886,6 +4036,15 @@ export declare const researchV1Registry: import("./core.js").PublicV1Registry<{
                         min: z.ZodNumber;
                         max: z.ZodNumber;
                     }, z.core.$strict>>;
+                    /**
+                     * Why a result set is empty, in one sentence for a person.
+                     *
+                     * The provider answers 200 with an empty list both when the argument was
+                     * refused and when the argument was accepted but matched nothing. `message`
+                     * is the only field that tells the two apart, so a caller that reads the list
+                     * alone will misread a refusal as an absence of demand. Present only when the
+                     * list is empty for a reason worth naming.
+                     */
                     readonly message: z.ZodOptional<z.ZodString>;
                     readonly cached: z.ZodBoolean;
                 }, z.core.$strip>;
@@ -3927,6 +4086,15 @@ export declare const researchV1Registry: import("./core.js").PublicV1Registry<{
                         min: z.ZodNumber;
                         max: z.ZodNumber;
                     }, z.core.$loose>>;
+                    /**
+                     * Why a result set is empty, in one sentence for a person.
+                     *
+                     * The provider answers 200 with an empty list both when the argument was
+                     * refused and when the argument was accepted but matched nothing. `message`
+                     * is the only field that tells the two apart, so a caller that reads the list
+                     * alone will misread a refusal as an absence of demand. Present only when the
+                     * list is empty for a reason worth naming.
+                     */
                     readonly message: z.ZodOptional<z.ZodString>;
                     readonly cached: z.ZodBoolean;
                 }, z.core.$strip>;

package/dist/v1/research.js

@@ -202,7 +202,19 @@ const keywordResearchDataSchema = defineResponseObject({
         maxDifficulty: schema.number(),
         intent: schema.string().optional(),
     }),
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     message: schema.string().optional(),
+    /**
+     * A concrete next argument to try, when `message` names a fixable argument.
+     */
     tip: schema.string().optional(),
     serpFallback: schema.strictObject({
         message: schema.string(),
@@ -221,7 +233,19 @@ const keywordResearchDataSchema = defineResponseObject({
         maxDifficulty: schema.number(),
         intent: schema.string().optional(),
     }),
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     message: schema.string().optional(),
+    /**
+     * A concrete next argument to try, when `message` names a fixable argument.
+     */
     tip: schema.string().optional(),
     serpFallback: schema.looseObject({
         message: schema.string(),
@@ -318,6 +342,15 @@ const rankingsResearchDataSchema = defineResponseObject({
     totalFound: schema.number().int().nonnegative(),
     metrics: rankingMetricsSchema.producer.nullable(),
     positionRange: schema.strictObject({ min: schema.number(), max: schema.number() }).optional(),
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     message: schema.string().optional(),
     cached: schema.boolean(),
 }, {
@@ -326,6 +359,15 @@ const rankingsResearchDataSchema = defineResponseObject({
     totalFound: schema.number().int().nonnegative(),
     metrics: rankingMetricsSchema.client.nullable(),
     positionRange: schema.looseObject({ min: schema.number(), max: schema.number() }).optional(),
+    /**
+     * Why a result set is empty, in one sentence for a person.
+     *
+     * The provider answers 200 with an empty list both when the argument was
+     * refused and when the argument was accepted but matched nothing. `message`
+     * is the only field that tells the two apart, so a caller that reads the list
+     * alone will misread a refusal as an absence of demand. Present only when the
+     * list is empty for a reason worth naming.
+     */
     message: schema.string().optional(),
     cached: schema.boolean(),
 });