@wix/auto_sdk_stores_collections 1.0.37 → 1.0.38

package/build/es/index.typings.mjs

@@ -168,6 +168,507 @@ function getCollectionBySlug(payload) {
 
 // src/stores-catalog-v1-collection-collections.universal.ts
 import { transformPaths as transformPaths2 } from "@wix/sdk-runtime/transformations/transform-paths";
+
+// src/stores-catalog-v1-collection-collections.schemas.ts
+import * as z from "zod";
+var QueryCollectionsRequest = z.object({
+  query: z.intersection(
+    z.object({
+      filter: z.record(z.string(), z.any()).describe("Filter object.").optional().nullable(),
+      sort: z.array(
+        z.object({
+          fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
+          order: z.enum(["ASC", "DESC"]).optional()
+        })
+      ).optional()
+    }),
+    z.xor([
+      z.object({
+        paging: z.never().optional(),
+        cursorPaging: z.never().optional()
+      }),
+      z.object({
+        cursorPaging: z.never().optional(),
+        paging: z.object({
+          limit: z.number().int().describe("Number of items to load.").min(0).max(100).optional().nullable(),
+          offset: z.number().int().describe("Number of items to skip in the current sort order.").min(0).optional().nullable()
+        }).describe(
+          "Pointer to page of results using offset. Cannot be used together with `cursorPaging`."
+        )
+      }),
+      z.object({
+        paging: z.never().optional(),
+        cursorPaging: z.object({
+          limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
+          cursor: z.string().describe(
+            "Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
+          ).max(16e3).optional().nullable()
+        }).describe(
+          "Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`."
+        )
+      })
+    ])
+  )
+});
+var QueryCollectionsResponse = z.object({
+  collections: z.array(
+    z.object({
+      _id: z.string().describe("Collection ID (generated automatically by the catalog).").min(35).max(36).optional().nullable(),
+      name: z.string().describe("Collection name.").min(1).max(50).optional().nullable(),
+      media: z.object({
+        mainMedia: z.intersection(
+          z.object({
+            thumbnail: z.object({
+              url: z.string().describe("Media item URL.").url().optional(),
+              width: z.number().int().describe("Media item width.").min(0).optional(),
+              height: z.number().int().describe("Media item height.").min(0).optional(),
+              format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+              altText: z.string().describe(
+                "Alt text. This text will be shown in case the image is not available."
+              ).optional().nullable()
+            }).describe("Media item thumbnail details.").optional(),
+            mediaType: z.enum([
+              "unspecified_media_item_type",
+              "image",
+              "video",
+              "audio",
+              "document",
+              "zip"
+            ]).describe("Media item type (image, video, etc.).").optional(),
+            title: z.string().describe("Media item title.").optional(),
+            _id: z.string().describe(
+              'Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`).'
+            ).optional()
+          }),
+          z.xor([
+            z.object({
+              image: z.never().optional(),
+              video: z.never().optional()
+            }),
+            z.object({
+              video: z.never().optional(),
+              image: z.object({
+                url: z.string().describe("Media item URL.").url().optional(),
+                width: z.number().int().describe("Media item width.").min(0).optional(),
+                height: z.number().int().describe("Media item height.").min(0).optional(),
+                format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                altText: z.string().describe(
+                  "Alt text. This text will be shown in case the image is not available."
+                ).optional().nullable()
+              }).describe("Image data (URL, size).")
+            }),
+            z.object({
+              image: z.never().optional(),
+              video: z.object({
+                files: z.array(
+                  z.object({
+                    url: z.string().describe("Media item URL.").url().optional(),
+                    width: z.number().int().describe("Media item width.").min(0).optional(),
+                    height: z.number().int().describe("Media item height.").min(0).optional(),
+                    format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                    altText: z.string().describe(
+                      "Alt text. This text will be shown in case the image is not available."
+                    ).optional().nullable()
+                  })
+                ).optional(),
+                stillFrameMediaId: z.string().describe(
+                  'ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`.'
+                ).optional()
+              }).describe("Video data (URL, size).")
+            })
+          ])
+        ).describe(
+          "Primary media (image, video etc) associated with this product."
+        ).optional(),
+        items: z.array(
+          z.intersection(
+            z.object({
+              thumbnail: z.object({
+                url: z.string().describe("Media item URL.").url().optional(),
+                width: z.number().int().describe("Media item width.").min(0).optional(),
+                height: z.number().int().describe("Media item height.").min(0).optional(),
+                format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                altText: z.string().describe(
+                  "Alt text. This text will be shown in case the image is not available."
+                ).optional().nullable()
+              }).describe("Media item thumbnail details.").optional(),
+              mediaType: z.enum([
+                "unspecified_media_item_type",
+                "image",
+                "video",
+                "audio",
+                "document",
+                "zip"
+              ]).describe("Media item type (image, video, etc.).").optional(),
+              title: z.string().describe("Media item title.").optional(),
+              _id: z.string().describe(
+                'Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`).'
+              ).optional()
+            }),
+            z.xor([
+              z.object({
+                image: z.never().optional(),
+                video: z.never().optional()
+              }),
+              z.object({
+                video: z.never().optional(),
+                image: z.object({
+                  url: z.string().describe("Media item URL.").url().optional(),
+                  width: z.number().int().describe("Media item width.").min(0).optional(),
+                  height: z.number().int().describe("Media item height.").min(0).optional(),
+                  format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                  altText: z.string().describe(
+                    "Alt text. This text will be shown in case the image is not available."
+                  ).optional().nullable()
+                }).describe("Image data (URL, size).")
+              }),
+              z.object({
+                image: z.never().optional(),
+                video: z.object({
+                  files: z.array(
+                    z.object({
+                      url: z.string().describe("Media item URL.").url().optional(),
+                      width: z.number().int().describe("Media item width.").min(0).optional(),
+                      height: z.number().int().describe("Media item height.").min(0).optional(),
+                      format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                      altText: z.string().describe(
+                        "Alt text. This text will be shown in case the image is not available."
+                      ).optional().nullable()
+                    })
+                  ).optional(),
+                  stillFrameMediaId: z.string().describe(
+                    'ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`.'
+                  ).optional()
+                }).describe("Video data (URL, size).")
+              })
+            ])
+          )
+        ).optional()
+      }).describe(
+        "Media items (images, videos etc) associated with this collection. Read only."
+      ).optional(),
+      numberOfProducts: z.number().int().describe("Number of products in the collection. Read only.").optional(),
+      description: z.string().describe("Collection description.").min(0).max(600).optional().nullable(),
+      slug: z.string().describe("Collection slug.").min(1).max(100).optional().nullable(),
+      visible: z.boolean().describe(
+        "Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`."
+      ).optional().nullable()
+    })
+  ).max(100).optional(),
+  metadata: z.object({
+    count: z.number().int().describe("The number of items returned in this response.").optional().nullable(),
+    offset: z.number().int().describe(
+      "The offset which was requested. Returned if offset paging was used."
+    ).optional().nullable(),
+    total: z.number().int().describe(
+      "The total number of items that match the query. Returned if offset paging was used."
+    ).optional().nullable(),
+    cursors: z.object({
+      next: z.string().describe(
+        "Cursor string pointing to the next page in the list of results."
+      ).max(16e3).optional().nullable(),
+      prev: z.string().describe(
+        "Cursor pointing to the previous page in the list of results."
+      ).max(16e3).optional().nullable()
+    }).describe(
+      "Cursors to navigate through result pages. Returned if cursor paging was used."
+    ).optional()
+  }).optional()
+});
+var GetCollectionRequest = z.object({
+  _id: z.string().describe("Requested collection ID.")
+});
+var GetCollectionResponse = z.object({
+  _id: z.string().describe("Collection ID (generated automatically by the catalog).").min(35).max(36).optional().nullable(),
+  name: z.string().describe("Collection name.").min(1).max(50).optional().nullable(),
+  media: z.object({
+    mainMedia: z.intersection(
+      z.object({
+        thumbnail: z.object({
+          url: z.string().describe("Media item URL.").url().optional(),
+          width: z.number().int().describe("Media item width.").min(0).optional(),
+          height: z.number().int().describe("Media item height.").min(0).optional(),
+          format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+          altText: z.string().describe(
+            "Alt text. This text will be shown in case the image is not available."
+          ).optional().nullable()
+        }).describe("Media item thumbnail details.").optional(),
+        mediaType: z.enum([
+          "unspecified_media_item_type",
+          "image",
+          "video",
+          "audio",
+          "document",
+          "zip"
+        ]).describe("Media item type (image, video, etc.).").optional(),
+        title: z.string().describe("Media item title.").optional(),
+        _id: z.string().describe(
+          'Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`).'
+        ).optional()
+      }),
+      z.xor([
+        z.object({
+          image: z.never().optional(),
+          video: z.never().optional()
+        }),
+        z.object({
+          video: z.never().optional(),
+          image: z.object({
+            url: z.string().describe("Media item URL.").url().optional(),
+            width: z.number().int().describe("Media item width.").min(0).optional(),
+            height: z.number().int().describe("Media item height.").min(0).optional(),
+            format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+            altText: z.string().describe(
+              "Alt text. This text will be shown in case the image is not available."
+            ).optional().nullable()
+          }).describe("Image data (URL, size).")
+        }),
+        z.object({
+          image: z.never().optional(),
+          video: z.object({
+            files: z.array(
+              z.object({
+                url: z.string().describe("Media item URL.").url().optional(),
+                width: z.number().int().describe("Media item width.").min(0).optional(),
+                height: z.number().int().describe("Media item height.").min(0).optional(),
+                format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                altText: z.string().describe(
+                  "Alt text. This text will be shown in case the image is not available."
+                ).optional().nullable()
+              })
+            ).optional(),
+            stillFrameMediaId: z.string().describe(
+              'ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`.'
+            ).optional()
+          }).describe("Video data (URL, size).")
+        })
+      ])
+    ).describe(
+      "Primary media (image, video etc) associated with this product."
+    ).optional(),
+    items: z.array(
+      z.intersection(
+        z.object({
+          thumbnail: z.object({
+            url: z.string().describe("Media item URL.").url().optional(),
+            width: z.number().int().describe("Media item width.").min(0).optional(),
+            height: z.number().int().describe("Media item height.").min(0).optional(),
+            format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+            altText: z.string().describe(
+              "Alt text. This text will be shown in case the image is not available."
+            ).optional().nullable()
+          }).describe("Media item thumbnail details.").optional(),
+          mediaType: z.enum([
+            "unspecified_media_item_type",
+            "image",
+            "video",
+            "audio",
+            "document",
+            "zip"
+          ]).describe("Media item type (image, video, etc.).").optional(),
+          title: z.string().describe("Media item title.").optional(),
+          _id: z.string().describe(
+            'Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`).'
+          ).optional()
+        }),
+        z.xor([
+          z.object({
+            image: z.never().optional(),
+            video: z.never().optional()
+          }),
+          z.object({
+            video: z.never().optional(),
+            image: z.object({
+              url: z.string().describe("Media item URL.").url().optional(),
+              width: z.number().int().describe("Media item width.").min(0).optional(),
+              height: z.number().int().describe("Media item height.").min(0).optional(),
+              format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+              altText: z.string().describe(
+                "Alt text. This text will be shown in case the image is not available."
+              ).optional().nullable()
+            }).describe("Image data (URL, size).")
+          }),
+          z.object({
+            image: z.never().optional(),
+            video: z.object({
+              files: z.array(
+                z.object({
+                  url: z.string().describe("Media item URL.").url().optional(),
+                  width: z.number().int().describe("Media item width.").min(0).optional(),
+                  height: z.number().int().describe("Media item height.").min(0).optional(),
+                  format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                  altText: z.string().describe(
+                    "Alt text. This text will be shown in case the image is not available."
+                  ).optional().nullable()
+                })
+              ).optional(),
+              stillFrameMediaId: z.string().describe(
+                'ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`.'
+              ).optional()
+            }).describe("Video data (URL, size).")
+          })
+        ])
+      )
+    ).optional()
+  }).describe(
+    "Media items (images, videos etc) associated with this collection. Read only."
+  ).optional(),
+  numberOfProducts: z.number().int().describe("Number of products in the collection. Read only.").optional(),
+  description: z.string().describe("Collection description.").min(0).max(600).optional().nullable(),
+  slug: z.string().describe("Collection slug.").min(1).max(100).optional().nullable(),
+  visible: z.boolean().describe(
+    "Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`."
+  ).optional().nullable()
+});
+var GetCollectionBySlugRequest = z.object({
+  slug: z.string().describe("Slug of the collection to retrieve.").min(1).max(100)
+});
+var GetCollectionBySlugResponse = z.object({
+  collection: z.object({
+    _id: z.string().describe("Collection ID (generated automatically by the catalog).").min(35).max(36).optional().nullable(),
+    name: z.string().describe("Collection name.").min(1).max(50).optional().nullable(),
+    media: z.object({
+      mainMedia: z.intersection(
+        z.object({
+          thumbnail: z.object({
+            url: z.string().describe("Media item URL.").url().optional(),
+            width: z.number().int().describe("Media item width.").min(0).optional(),
+            height: z.number().int().describe("Media item height.").min(0).optional(),
+            format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+            altText: z.string().describe(
+              "Alt text. This text will be shown in case the image is not available."
+            ).optional().nullable()
+          }).describe("Media item thumbnail details.").optional(),
+          mediaType: z.enum([
+            "unspecified_media_item_type",
+            "image",
+            "video",
+            "audio",
+            "document",
+            "zip"
+          ]).describe("Media item type (image, video, etc.).").optional(),
+          title: z.string().describe("Media item title.").optional(),
+          _id: z.string().describe(
+            'Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`).'
+          ).optional()
+        }),
+        z.xor([
+          z.object({
+            image: z.never().optional(),
+            video: z.never().optional()
+          }),
+          z.object({
+            video: z.never().optional(),
+            image: z.object({
+              url: z.string().describe("Media item URL.").url().optional(),
+              width: z.number().int().describe("Media item width.").min(0).optional(),
+              height: z.number().int().describe("Media item height.").min(0).optional(),
+              format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+              altText: z.string().describe(
+                "Alt text. This text will be shown in case the image is not available."
+              ).optional().nullable()
+            }).describe("Image data (URL, size).")
+          }),
+          z.object({
+            image: z.never().optional(),
+            video: z.object({
+              files: z.array(
+                z.object({
+                  url: z.string().describe("Media item URL.").url().optional(),
+                  width: z.number().int().describe("Media item width.").min(0).optional(),
+                  height: z.number().int().describe("Media item height.").min(0).optional(),
+                  format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                  altText: z.string().describe(
+                    "Alt text. This text will be shown in case the image is not available."
+                  ).optional().nullable()
+                })
+              ).optional(),
+              stillFrameMediaId: z.string().describe(
+                'ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`.'
+              ).optional()
+            }).describe("Video data (URL, size).")
+          })
+        ])
+      ).describe(
+        "Primary media (image, video etc) associated with this product."
+      ).optional(),
+      items: z.array(
+        z.intersection(
+          z.object({
+            thumbnail: z.object({
+              url: z.string().describe("Media item URL.").url().optional(),
+              width: z.number().int().describe("Media item width.").min(0).optional(),
+              height: z.number().int().describe("Media item height.").min(0).optional(),
+              format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+              altText: z.string().describe(
+                "Alt text. This text will be shown in case the image is not available."
+              ).optional().nullable()
+            }).describe("Media item thumbnail details.").optional(),
+            mediaType: z.enum([
+              "unspecified_media_item_type",
+              "image",
+              "video",
+              "audio",
+              "document",
+              "zip"
+            ]).describe("Media item type (image, video, etc.).").optional(),
+            title: z.string().describe("Media item title.").optional(),
+            _id: z.string().describe(
+              'Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`).'
+            ).optional()
+          }),
+          z.xor([
+            z.object({
+              image: z.never().optional(),
+              video: z.never().optional()
+            }),
+            z.object({
+              video: z.never().optional(),
+              image: z.object({
+                url: z.string().describe("Media item URL.").url().optional(),
+                width: z.number().int().describe("Media item width.").min(0).optional(),
+                height: z.number().int().describe("Media item height.").min(0).optional(),
+                format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                altText: z.string().describe(
+                  "Alt text. This text will be shown in case the image is not available."
+                ).optional().nullable()
+              }).describe("Image data (URL, size).")
+            }),
+            z.object({
+              image: z.never().optional(),
+              video: z.object({
+                files: z.array(
+                  z.object({
+                    url: z.string().describe("Media item URL.").url().optional(),
+                    width: z.number().int().describe("Media item width.").min(0).optional(),
+                    height: z.number().int().describe("Media item height.").min(0).optional(),
+                    format: z.string().describe("Media format (mp4, png, etc.).").optional().nullable(),
+                    altText: z.string().describe(
+                      "Alt text. This text will be shown in case the image is not available."
+                    ).optional().nullable()
+                  })
+                ).optional(),
+                stillFrameMediaId: z.string().describe(
+                  'ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`.'
+                ).optional()
+              }).describe("Video data (URL, size).")
+            })
+          ])
+        )
+      ).optional()
+    }).describe(
+      "Media items (images, videos etc) associated with this collection. Read only."
+    ).optional(),
+    numberOfProducts: z.number().int().describe("Number of products in the collection. Read only.").optional(),
+    description: z.string().describe("Collection description.").min(0).max(600).optional().nullable(),
+    slug: z.string().describe("Collection slug.").min(1).max(100).optional().nullable(),
+    visible: z.boolean().describe(
+      "Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`."
+    ).optional().nullable()
+  }).describe("The requested collection.").optional()
+});
+
+// src/stores-catalog-v1-collection-collections.universal.ts
 import { createQueryUtils } from "@wix/sdk-runtime/query-builder-utils";
 var MediaItemType = /* @__PURE__ */ ((MediaItemType2) => {
   MediaItemType2["unspecified_media_item_type"] = "unspecified_media_item_type";
@@ -227,7 +728,10 @@ function queryCollections2() {
   });
 }
 async function typedQueryCollections(query) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    QueryCollectionsRequest.parse({ query });
+  }
   const payload = renameKeysFromSDKRequestToRESTRequest({ query });
   const reqOpts = queryCollections(payload);
   sideEffects?.onSiteCall?.();
@@ -255,7 +759,10 @@ var utils = {
   }
 };
 async function getCollection2(_id) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    GetCollectionRequest.parse({ _id });
+  }
   const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
   const reqOpts = getCollection(payload);
   sideEffects?.onSiteCall?.();
@@ -278,7 +785,10 @@ async function getCollection2(_id) {
   }
 }
 async function getCollectionBySlug2(slug) {
-  const { httpClient, sideEffects } = arguments[1];
+  const { httpClient, sideEffects, validateRequestSchema } = arguments[1];
+  if (validateRequestSchema) {
+    GetCollectionBySlugRequest.parse({ slug });
+  }
   const payload = renameKeysFromSDKRequestToRESTRequest({ slug });
   const reqOpts = getCollectionBySlug(payload);
   sideEffects?.onSiteCall?.();