npm - @nuxtseo/protocol - Versions diffs - 0.2.1 → 0.3.0 - Mend

@nuxtseo/protocol 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/dist/v1/sites.d.ts CHANGED Viewed

@@ -65,6 +65,9 @@ export declare const siteSummaryClientSchema: z.ZodObject<{
     }, z.core.$loose>;
 }, z.core.$loose>;
 export declare const sitesListDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
+    /**
+     * Deprecated alias of `rows`. Kept for one minor version, then removed.
+     */
     readonly sites: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodNullable<z.ZodString>;
@@ -90,6 +93,37 @@ export declare const sitesListDataSchema: import("./core.js").CompatibleResponse
             analysisAvailable: z.ZodBoolean;
         }, z.core.$strict>;
     }, z.core.$strict>>;
+    readonly rows: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        url: z.ZodNullable<z.ZodURL>;
+        searchConsole: z.ZodObject<{
+            status: z.ZodEnum<{
+                action_required: "action_required";
+                connected: "connected";
+                disconnected: "disconnected";
+            }>;
+        }, z.core.$strict>;
+        monitoring: z.ZodObject<{
+            mode: z.ZodNullable<z.ZodEnum<{
+                full_monitoring: "full_monitoring";
+                search_tracking: "search_tracking";
+            }>>;
+            status: z.ZodEnum<{
+                active: "active";
+                archived: "archived";
+                paused: "paused";
+                unconfigured: "unconfigured";
+            }>;
+            analysisAvailable: z.ZodBoolean;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+    readonly page: z.ZodObject<{
+        readonly total: z.ZodNumber;
+        readonly limit: z.ZodNumber;
+        readonly offset: z.ZodNumber;
+        readonly hasMore: z.ZodBoolean;
+    }, z.core.$strip>;
 }, z.core.$strip>, z.ZodObject<{
     readonly sites: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -116,6 +150,37 @@ export declare const sitesListDataSchema: import("./core.js").CompatibleResponse
             analysisAvailable: z.ZodBoolean;
         }, z.core.$loose>;
     }, z.core.$loose>>;
+    readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        url: z.ZodNullable<z.ZodURL>;
+        searchConsole: z.ZodObject<{
+            status: z.ZodEnum<{
+                action_required: "action_required";
+                connected: "connected";
+                disconnected: "disconnected";
+            }>;
+        }, z.core.$loose>;
+        monitoring: z.ZodObject<{
+            mode: z.ZodNullable<z.ZodEnum<{
+                full_monitoring: "full_monitoring";
+                search_tracking: "search_tracking";
+            }>>;
+            status: z.ZodEnum<{
+                active: "active";
+                archived: "archived";
+                paused: "paused";
+                unconfigured: "unconfigured";
+            }>;
+            analysisAvailable: z.ZodBoolean;
+        }, z.core.$loose>;
+    }, z.core.$loose>>>;
+    readonly page: z.ZodOptional<z.ZodObject<{
+        readonly total: z.ZodNumber;
+        readonly limit: z.ZodNumber;
+        readonly offset: z.ZodNumber;
+        readonly hasMore: z.ZodBoolean;
+    }, z.core.$strip>>;
 }, z.core.$strip>>;
 export declare const sitesListMetaSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
     readonly requestId: z.ZodString;
@@ -128,6 +193,9 @@ export declare const sitesListMetaSchema: import("./core.js").CompatibleResponse
 }, z.core.$strip>>;
 export declare const sitesListResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
     data: z.ZodObject<{
+        /**
+         * Deprecated alias of `rows`. Kept for one minor version, then removed.
+         */
         readonly sites: z.ZodArray<z.ZodObject<{
             id: z.ZodString;
             name: z.ZodNullable<z.ZodString>;
@@ -153,6 +221,37 @@ export declare const sitesListResponseSchema: import("./core.js").CompatibleResp
                 analysisAvailable: z.ZodBoolean;
             }, z.core.$strict>;
         }, z.core.$strict>>;
+        readonly rows: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodNullable<z.ZodString>;
+            url: z.ZodNullable<z.ZodURL>;
+            searchConsole: z.ZodObject<{
+                status: z.ZodEnum<{
+                    action_required: "action_required";
+                    connected: "connected";
+                    disconnected: "disconnected";
+                }>;
+            }, z.core.$strict>;
+            monitoring: z.ZodObject<{
+                mode: z.ZodNullable<z.ZodEnum<{
+                    full_monitoring: "full_monitoring";
+                    search_tracking: "search_tracking";
+                }>>;
+                status: z.ZodEnum<{
+                    active: "active";
+                    archived: "archived";
+                    paused: "paused";
+                    unconfigured: "unconfigured";
+                }>;
+                analysisAvailable: z.ZodBoolean;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+        readonly page: z.ZodObject<{
+            readonly total: z.ZodNumber;
+            readonly limit: z.ZodNumber;
+            readonly offset: z.ZodNumber;
+            readonly hasMore: z.ZodBoolean;
+        }, z.core.$strip>;
     }, z.core.$strip>;
     meta: z.ZodObject<{
         readonly requestId: z.ZodString;
@@ -186,6 +285,37 @@ export declare const sitesListResponseSchema: import("./core.js").CompatibleResp
                 analysisAvailable: z.ZodBoolean;
             }, z.core.$loose>;
         }, z.core.$loose>>;
+        readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodNullable<z.ZodString>;
+            url: z.ZodNullable<z.ZodURL>;
+            searchConsole: z.ZodObject<{
+                status: z.ZodEnum<{
+                    action_required: "action_required";
+                    connected: "connected";
+                    disconnected: "disconnected";
+                }>;
+            }, z.core.$loose>;
+            monitoring: z.ZodObject<{
+                mode: z.ZodNullable<z.ZodEnum<{
+                    full_monitoring: "full_monitoring";
+                    search_tracking: "search_tracking";
+                }>>;
+                status: z.ZodEnum<{
+                    active: "active";
+                    archived: "archived";
+                    paused: "paused";
+                    unconfigured: "unconfigured";
+                }>;
+                analysisAvailable: z.ZodBoolean;
+            }, z.core.$loose>;
+        }, z.core.$loose>>>;
+        readonly page: z.ZodOptional<z.ZodObject<{
+            readonly total: z.ZodNumber;
+            readonly limit: z.ZodNumber;
+            readonly offset: z.ZodNumber;
+            readonly hasMore: z.ZodBoolean;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     meta: z.ZodObject<{
         readonly requestId: z.ZodString;
@@ -221,6 +351,9 @@ export declare const sitesListOperation: {
     readonly responses: {
         readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
             data: z.ZodObject<{
+                /**
+                 * Deprecated alias of `rows`. Kept for one minor version, then removed.
+                 */
                 readonly sites: z.ZodArray<z.ZodObject<{
                     id: z.ZodString;
                     name: z.ZodNullable<z.ZodString>;
@@ -246,6 +379,37 @@ export declare const sitesListOperation: {
                         analysisAvailable: z.ZodBoolean;
                     }, z.core.$strict>;
                 }, z.core.$strict>>;
+                readonly rows: z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    name: z.ZodNullable<z.ZodString>;
+                    url: z.ZodNullable<z.ZodURL>;
+                    searchConsole: z.ZodObject<{
+                        status: z.ZodEnum<{
+                            action_required: "action_required";
+                            connected: "connected";
+                            disconnected: "disconnected";
+                        }>;
+                    }, z.core.$strict>;
+                    monitoring: z.ZodObject<{
+                        mode: z.ZodNullable<z.ZodEnum<{
+                            full_monitoring: "full_monitoring";
+                            search_tracking: "search_tracking";
+                        }>>;
+                        status: z.ZodEnum<{
+                            active: "active";
+                            archived: "archived";
+                            paused: "paused";
+                            unconfigured: "unconfigured";
+                        }>;
+                        analysisAvailable: z.ZodBoolean;
+                    }, z.core.$strict>;
+                }, z.core.$strict>>;
+                readonly page: z.ZodObject<{
+                    readonly total: z.ZodNumber;
+                    readonly limit: z.ZodNumber;
+                    readonly offset: z.ZodNumber;
+                    readonly hasMore: z.ZodBoolean;
+                }, z.core.$strip>;
             }, z.core.$strip>;
             meta: z.ZodObject<{
                 readonly requestId: z.ZodString;
@@ -279,6 +443,37 @@ export declare const sitesListOperation: {
                         analysisAvailable: z.ZodBoolean;
                     }, z.core.$loose>;
                 }, z.core.$loose>>;
+                readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    name: z.ZodNullable<z.ZodString>;
+                    url: z.ZodNullable<z.ZodURL>;
+                    searchConsole: z.ZodObject<{
+                        status: z.ZodEnum<{
+                            action_required: "action_required";
+                            connected: "connected";
+                            disconnected: "disconnected";
+                        }>;
+                    }, z.core.$loose>;
+                    monitoring: z.ZodObject<{
+                        mode: z.ZodNullable<z.ZodEnum<{
+                            full_monitoring: "full_monitoring";
+                            search_tracking: "search_tracking";
+                        }>>;
+                        status: z.ZodEnum<{
+                            active: "active";
+                            archived: "archived";
+                            paused: "paused";
+                            unconfigured: "unconfigured";
+                        }>;
+                        analysisAvailable: z.ZodBoolean;
+                    }, z.core.$loose>;
+                }, z.core.$loose>>>;
+                readonly page: z.ZodOptional<z.ZodObject<{
+                    readonly total: z.ZodNumber;
+                    readonly limit: z.ZodNumber;
+                    readonly offset: z.ZodNumber;
+                    readonly hasMore: z.ZodBoolean;
+                }, z.core.$strip>>;
             }, z.core.$strip>;
             meta: z.ZodObject<{
                 readonly requestId: z.ZodString;
@@ -380,6 +575,25 @@ export declare const sitesListOperation: {
                                 readonly analysisAvailable: true;
                             };
                         }];
+                        readonly rows: readonly [{
+                            readonly id: 'site_01JXYZ';
+                            readonly name: 'Example';
+                            readonly url: 'https://example.com/';
+                            readonly searchConsole: {
+                                readonly status: 'connected';
+                            };
+                            readonly monitoring: {
+                                readonly mode: 'full_monitoring';
+                                readonly status: 'active';
+                                readonly analysisAvailable: true;
+                            };
+                        }];
+                        readonly page: {
+                            readonly total: 1;
+                            readonly limit: 1;
+                            readonly offset: 0;
+                            readonly hasMore: false;
+                        };
                     };
                     readonly meta: {
                         readonly requestId: 'req_01JXYZ';
@@ -1120,6 +1334,9 @@ export declare const sitesV1Registry: import("./core.js").PublicV1Registry<{
         readonly responses: {
             readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
                 data: z.ZodObject<{
+                    /**
+                     * Deprecated alias of `rows`. Kept for one minor version, then removed.
+                     */
                     readonly sites: z.ZodArray<z.ZodObject<{
                         id: z.ZodString;
                         name: z.ZodNullable<z.ZodString>;
@@ -1145,6 +1362,37 @@ export declare const sitesV1Registry: import("./core.js").PublicV1Registry<{
                             analysisAvailable: z.ZodBoolean;
                         }, z.core.$strict>;
                     }, z.core.$strict>>;
+                    readonly rows: z.ZodArray<z.ZodObject<{
+                        id: z.ZodString;
+                        name: z.ZodNullable<z.ZodString>;
+                        url: z.ZodNullable<z.ZodURL>;
+                        searchConsole: z.ZodObject<{
+                            status: z.ZodEnum<{
+                                action_required: "action_required";
+                                connected: "connected";
+                                disconnected: "disconnected";
+                            }>;
+                        }, z.core.$strict>;
+                        monitoring: z.ZodObject<{
+                            mode: z.ZodNullable<z.ZodEnum<{
+                                full_monitoring: "full_monitoring";
+                                search_tracking: "search_tracking";
+                            }>>;
+                            status: z.ZodEnum<{
+                                active: "active";
+                                archived: "archived";
+                                paused: "paused";
+                                unconfigured: "unconfigured";
+                            }>;
+                            analysisAvailable: z.ZodBoolean;
+                        }, z.core.$strict>;
+                    }, z.core.$strict>>;
+                    readonly page: z.ZodObject<{
+                        readonly total: z.ZodNumber;
+                        readonly limit: z.ZodNumber;
+                        readonly offset: z.ZodNumber;
+                        readonly hasMore: z.ZodBoolean;
+                    }, z.core.$strip>;
                 }, z.core.$strip>;
                 meta: z.ZodObject<{
                     readonly requestId: z.ZodString;
@@ -1178,6 +1426,37 @@ export declare const sitesV1Registry: import("./core.js").PublicV1Registry<{
                             analysisAvailable: z.ZodBoolean;
                         }, z.core.$loose>;
                     }, z.core.$loose>>;
+                    readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                        id: z.ZodString;
+                        name: z.ZodNullable<z.ZodString>;
+                        url: z.ZodNullable<z.ZodURL>;
+                        searchConsole: z.ZodObject<{
+                            status: z.ZodEnum<{
+                                action_required: "action_required";
+                                connected: "connected";
+                                disconnected: "disconnected";
+                            }>;
+                        }, z.core.$loose>;
+                        monitoring: z.ZodObject<{
+                            mode: z.ZodNullable<z.ZodEnum<{
+                                full_monitoring: "full_monitoring";
+                                search_tracking: "search_tracking";
+                            }>>;
+                            status: z.ZodEnum<{
+                                active: "active";
+                                archived: "archived";
+                                paused: "paused";
+                                unconfigured: "unconfigured";
+                            }>;
+                            analysisAvailable: z.ZodBoolean;
+                        }, z.core.$loose>;
+                    }, z.core.$loose>>>;
+                    readonly page: z.ZodOptional<z.ZodObject<{
+                        readonly total: z.ZodNumber;
+                        readonly limit: z.ZodNumber;
+                        readonly offset: z.ZodNumber;
+                        readonly hasMore: z.ZodBoolean;
+                    }, z.core.$strip>>;
                 }, z.core.$strip>;
                 meta: z.ZodObject<{
                     readonly requestId: z.ZodString;
@@ -1279,6 +1558,25 @@ export declare const sitesV1Registry: import("./core.js").PublicV1Registry<{
                                     readonly analysisAvailable: true;
                                 };
                             }];
+                            readonly rows: readonly [{
+                                readonly id: 'site_01JXYZ';
+                                readonly name: 'Example';
+                                readonly url: 'https://example.com/';
+                                readonly searchConsole: {
+                                    readonly status: 'connected';
+                                };
+                                readonly monitoring: {
+                                    readonly mode: 'full_monitoring';
+                                    readonly status: 'active';
+                                    readonly analysisAvailable: true;
+                                };
+                            }];
+                            readonly page: {
+                                readonly total: 1;
+                                readonly limit: 1;
+                                readonly offset: 0;
+                                readonly hasMore: false;
+                            };
                         };
                         readonly meta: {
                             readonly requestId: 'req_01JXYZ';

package/dist/v1/sites.js CHANGED Viewed

@@ -1,5 +1,5 @@
 import { z as schema } from 'zod';
-import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1MetaClientSchema, publicV1MetaProducerSchema, publicV1StandardRatePolicy, } from './core.js';
+import { defineOperation, defineRegistry, defineResponseObject, defineSuccessEnvelope, publicV1ErrorEnvelope, publicV1MetaClientSchema, publicV1MetaProducerSchema, publicV1PageSchema, publicV1StandardRatePolicy, } from './core.js';
 export const siteSearchConsoleStatusSchema = schema.enum(['connected', 'disconnected', 'action_required']);
 export const siteMonitoringModeSchema = schema.enum(['search_tracking', 'full_monitoring']).nullable();
 export const siteMonitoringStatusSchema = schema.enum(['active', 'paused', 'archived', 'unconfigured']);
@@ -29,7 +29,18 @@ export const siteSummaryClientSchema = schema.looseObject({
         analysisAvailable: schema.boolean(),
     }),
 });
-export const sitesListDataSchema = defineResponseObject({ sites: schema.array(siteSummaryProducerSchema) }, { sites: schema.array(siteSummaryClientSchema) });
+export const sitesListDataSchema = defineResponseObject({
+    /**
+     * Deprecated alias of `rows`. Kept for one minor version, then removed.
+     */
+    sites: schema.array(siteSummaryProducerSchema),
+    rows: schema.array(siteSummaryProducerSchema),
+    page: publicV1PageSchema.producer,
+}, {
+    sites: schema.array(siteSummaryClientSchema),
+    rows: schema.array(siteSummaryClientSchema).optional(),
+    page: publicV1PageSchema.client.optional(),
+});
 export const sitesListMetaSchema = defineResponseObject({ ...publicV1MetaProducerSchema.shape, total: schema.number().int().nonnegative() }, { ...publicV1MetaClientSchema.shape, total: schema.number().int().nonnegative() });
 export const sitesListResponseSchema = defineSuccessEnvelope(sitesListDataSchema, sitesListMetaSchema);
 export const sitesListOperation = defineOperation({
@@ -86,6 +97,14 @@ export const sitesListOperation = defineOperation({
                                     searchConsole: { status: 'connected' },
                                     monitoring: { mode: 'full_monitoring', status: 'active', analysisAvailable: true },
                                 }],
+                            rows: [{
+                                    id: 'site_01JXYZ',
+                                    name: 'Example',
+                                    url: 'https://example.com/',
+                                    searchConsole: { status: 'connected' },
+                                    monitoring: { mode: 'full_monitoring', status: 'active', analysisAvailable: true },
+                                }],
+                            page: { total: 1, limit: 1, offset: 0, hasMore: false },
                         },
                         meta: { requestId: 'req_01JXYZ', version: '1.0', total: 1 },
                     },