@wix/auto_sdk_stores_collections 1.0.13 → 1.0.14

package/build/internal/es/index.typings.mjs

@@ -0,0 +1,272 @@
+// src/stores-catalog-v1-collection-collections.universal.ts
+import { transformError as sdkTransformError } from "@wix/sdk-runtime/transform-error";
+import { queryBuilder } from "@wix/sdk-runtime/query-builder";
+import {
+  renameKeysFromSDKRequestToRESTRequest,
+  renameKeysFromRESTResponseToSDKResponse
+} from "@wix/sdk-runtime/rename-all-nested-keys";
+
+// src/stores-catalog-v1-collection-collections.http.ts
+import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
+import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
+import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
+function resolveWixCatalogApiV2CollectionReadApiUrl(opts) {
+  const domainToMappings = {
+    "api._api_base_domain_": [
+      {
+        srcPath: "/wix-ecommerce-catalog-reader-web",
+        destPath: ""
+      }
+    ],
+    "manage._base_domain_": [
+      {
+        srcPath: "/wix-ecommerce-catalog-reader-web",
+        destPath: ""
+      }
+    ],
+    "www.wixapis.com": [
+      {
+        srcPath: "/stores-reader/v2/collections",
+        destPath: "/v2/collections"
+      },
+      {
+        srcPath: "/stores-reader/v2/inventoryItems",
+        destPath: "/v2/inventoryItems"
+      }
+    ],
+    "www._base_domain_": [
+      {
+        srcPath: "/wix-ecommerce-catalog-reader-web",
+        destPath: ""
+      }
+    ],
+    "editor._base_domain_": [
+      {
+        srcPath: "/_api/wix-ecommerce-catalog-reader-web",
+        destPath: ""
+      }
+    ],
+    "blocks._base_domain_": [
+      {
+        srcPath: "/_api/wix-ecommerce-catalog-reader-web",
+        destPath: ""
+      }
+    ],
+    "create.editorx": [
+      {
+        srcPath: "/_api/wix-ecommerce-catalog-reader-web",
+        destPath: ""
+      }
+    ],
+    _: [
+      {
+        srcPath: "/stores-reader/v2/inventoryItems",
+        destPath: "/v2/inventoryItems"
+      },
+      {
+        srcPath: "/stores-reader/v2/collections",
+        destPath: "/v2/collections"
+      }
+    ]
+  };
+  return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_stores_collections";
+function queryCollections(payload) {
+  function __queryCollections({ host }) {
+    const metadata = {
+      entityFqdn: "wix.stores.catalog.v1.collection",
+      method: "POST",
+      methodFqn: "wix.catalog.api.v2.CollectionReadApi.QueryCollections",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCatalogApiV2CollectionReadApiUrl({
+        protoPath: "/v2/collections/query",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "collections.lastUpdated" }]
+        }
+      ]),
+      fallback: [
+        {
+          method: "POST",
+          url: resolveWixCatalogApiV2CollectionReadApiUrl({
+            protoPath: "/v2/collections/query",
+            data: payload,
+            host
+          }),
+          data: payload
+        }
+      ]
+    };
+    return metadata;
+  }
+  return __queryCollections;
+}
+function getCollection(payload) {
+  function __getCollection({ host }) {
+    const metadata = {
+      entityFqdn: "wix.stores.catalog.v1.collection",
+      method: "GET",
+      methodFqn: "wix.catalog.api.v2.CollectionReadApi.GetCollection",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCatalogApiV2CollectionReadApiUrl({
+        protoPath: "/v2/collections/{id}",
+        data: payload,
+        host
+      }),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "collection.lastUpdated" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getCollection;
+}
+function getCollectionBySlug(payload) {
+  function __getCollectionBySlug({ host }) {
+    const metadata = {
+      entityFqdn: "wix.stores.catalog.v1.collection",
+      method: "GET",
+      methodFqn: "wix.catalog.api.v2.CollectionReadApi.GetCollectionBySlug",
+      packageName: PACKAGE_NAME,
+      url: resolveWixCatalogApiV2CollectionReadApiUrl({
+        protoPath: "/v2/collections/slug/{slug}",
+        data: payload,
+        host
+      }),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "collection.lastUpdated" }]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getCollectionBySlug;
+}
+
+// src/stores-catalog-v1-collection-collections.universal.ts
+import { transformPaths as transformPaths2 } from "@wix/sdk-runtime/transformations/transform-paths";
+var MediaItemType = /* @__PURE__ */ ((MediaItemType2) => {
+  MediaItemType2["unspecified_media_item_type"] = "unspecified_media_item_type";
+  MediaItemType2["image"] = "image";
+  MediaItemType2["video"] = "video";
+  MediaItemType2["audio"] = "audio";
+  MediaItemType2["document"] = "document";
+  MediaItemType2["zip"] = "zip";
+  return MediaItemType2;
+})(MediaItemType || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ASC"] = "ASC";
+  SortOrder2["DESC"] = "DESC";
+  return SortOrder2;
+})(SortOrder || {});
+function queryCollections2() {
+  const { httpClient, sideEffects } = arguments[0];
+  return queryBuilder({
+    func: async (payload) => {
+      const reqOpts = queryCollections(payload);
+      sideEffects?.onSiteCall?.();
+      try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return result;
+      } catch (err) {
+        sideEffects?.onError?.(err);
+        throw err;
+      }
+    },
+    requestTransformer: (query) => {
+      const args = [query, {}];
+      return renameKeysFromSDKRequestToRESTRequest({
+        ...args?.[1],
+        query: args?.[0]
+      });
+    },
+    responseTransformer: ({ data }) => {
+      const transformedData = renameKeysFromRESTResponseToSDKResponse(
+        transformPaths2(data, [])
+      );
+      return {
+        items: transformedData?.collections,
+        pagingMetadata: transformedData?.metadata
+      };
+    },
+    errorTransformer: (err) => {
+      const transformedError = sdkTransformError(err, {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { query: "$[0]" },
+        singleArgumentUnchanged: false
+      });
+      throw transformedError;
+    },
+    pagingMethod: "OFFSET",
+    transformationPaths: {}
+  });
+}
+async function getCollection2(_id) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });
+  const reqOpts = getCollection(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data)?.collection;
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { id: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["_id"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function getCollectionBySlug2(slug) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({ slug });
+  const reqOpts = getCollectionBySlug(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { slug: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["slug"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+export {
+  MediaItemType,
+  SortOrder,
+  getCollection2 as getCollection,
+  getCollectionBySlug2 as getCollectionBySlug,
+  queryCollections2 as queryCollections
+};
+//# sourceMappingURL=index.typings.mjs.map

package/build/internal/es/index.typings.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/stores-catalog-v1-collection-collections.universal.ts","../../../src/stores-catalog-v1-collection-collections.http.ts"],"sourcesContent":["import { transformError as sdkTransformError } from '@wix/sdk-runtime/transform-error';\nimport { queryBuilder } from '@wix/sdk-runtime/query-builder';\nimport {\n  renameKeysFromSDKRequestToRESTRequest,\n  renameKeysFromRESTResponseToSDKResponse,\n} from '@wix/sdk-runtime/rename-all-nested-keys';\nimport { HttpClient, HttpResponse, NonNullablePaths } from '@wix/sdk-types';\nimport * as ambassadorWixStoresCatalogV1Collection from './stores-catalog-v1-collection-collections.http.js';\n// @ts-ignore\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\n\nexport interface Collection {\n  /**\n   * Collection ID (generated automatically by the catalog).\n   * @minLength 35\n   * @maxLength 36\n   * @readonly\n   */\n  _id?: string | null;\n  /**\n   * Collection name.\n   * @minLength 1\n   * @maxLength 50\n   */\n  name?: string | null;\n  /**\n   * Media items (images, videos etc) associated with this collection. Read only.\n   * @readonly\n   */\n  media?: Media;\n  /**\n   * Number of products in the collection. Read only.\n   * @readonly\n   */\n  numberOfProducts?: number;\n  /**\n   * Collection description.\n   * @maxLength 600\n   */\n  description?: string | null;\n  /**\n   * Collection slug.\n   * @minLength 1\n   * @maxLength 100\n   */\n  slug?: string | null;\n  /** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */\n  visible?: boolean | null;\n  /**\n   * Date and time the collection was updated.\n   * @internal\n   * @readonly\n   */\n  lastUpdated?: Date | null;\n}\n\nexport interface Media {\n  /** Primary media (image, video etc) associated with this product. */\n  mainMedia?: MediaItem;\n  /** Media (images, videos etc) associated with this product. */\n  items?: MediaItem[];\n}\n\nexport interface MediaItem extends MediaItemItemOneOf {\n  /** Image data (URL, size). */\n  image?: MediaItemUrlAndSize;\n  /** Video data (URL, size). */\n  video?: MediaItemVideo;\n  /** Media item thumbnail details. */\n  thumbnail?: MediaItemUrlAndSize;\n  /** Media item type (image, video, etc.). */\n  mediaType?: MediaItemTypeWithLiterals;\n  /** Media item title. */\n  title?: string;\n  /** Media ID (for example, `\"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg\"`). */\n  _id?: string;\n}\n\n/** @oneof */\nexport interface MediaItemItemOneOf {\n  /** Image data (URL, size). */\n  image?: MediaItemUrlAndSize;\n  /** Video data (URL, size). */\n  video?: MediaItemVideo;\n}\n\nexport interface MediaItemUrlAndSize {\n  /**\n   * Media item URL.\n   * @format WEB_URL\n   */\n  url?: string;\n  /** Media item width. */\n  width?: number;\n  /** Media item height. */\n  height?: number;\n  /** Media format (mp4, png, etc.). */\n  format?: string | null;\n  /** Alt text. This text will be shown in case the image is not available. */\n  altText?: string | null;\n}\n\nexport enum MediaItemType {\n  unspecified_media_item_type = 'unspecified_media_item_type',\n  /** Image media type. */\n  image = 'image',\n  /** Video media type. */\n  video = 'video',\n  /** Audio media type. */\n  audio = 'audio',\n  /** Document media type. */\n  document = 'document',\n  /** Zip media type. */\n  zip = 'zip',\n}\n\n/** @enumType */\nexport type MediaItemTypeWithLiterals =\n  | MediaItemType\n  | 'unspecified_media_item_type'\n  | 'image'\n  | 'video'\n  | 'audio'\n  | 'document'\n  | 'zip';\n\nexport interface MediaItemVideo {\n  /** Data (URL, size) about each resolution for which this video is available. */\n  files?: MediaItemUrlAndSize[];\n  /** 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\"`. */\n  stillFrameMediaId?: string;\n}\n\n/**\n * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.\n * The search engines use this information for ranking purposes, or to display snippets in the search results.\n * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.\n */\nexport interface SeoSchema {\n  /** SEO tag information. */\n  tags?: Tag[];\n  /** SEO general settings. */\n  settings?: Settings;\n}\n\nexport interface Keyword {\n  /** Keyword value. */\n  term?: string;\n  /** Whether the keyword is the main focus keyword. */\n  isMain?: boolean;\n  /**\n   * The source that added the keyword terms to the SEO settings.\n   * @maxLength 1000\n   */\n  origin?: string | null;\n}\n\nexport interface Tag {\n  /**\n   * SEO tag type.\n   *\n   *\n   * Supported values: `title`, `meta`, `script`, `link`.\n   */\n  type?: string;\n  /**\n   * A `{\"key\": \"value\"}` pair object where each SEO tag property (`\"name\"`, `\"content\"`, `\"rel\"`, `\"href\"`) contains a value.\n   * For example: `{\"name\": \"description\", \"content\": \"the description itself\"}`.\n   */\n  props?: Record<string, any> | null;\n  /** SEO tag meta data. For example, `{\"height\": 300, \"width\": 240}`. */\n  meta?: Record<string, any> | null;\n  /** SEO tag inner content. For example, `<title> inner content </title>`. */\n  children?: string;\n  /** Whether the tag is a custom tag. */\n  custom?: boolean;\n  /** Whether the tag is disabled. */\n  disabled?: boolean;\n}\n\nexport interface Settings {\n  /**\n   * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.\n   *\n   *\n   * Default: `false` (Auto Redirect is enabled.)\n   */\n  preventAutoRedirect?: boolean;\n  /**\n   * User-selected keyword terms for a specific page.\n   * @maxSize 5\n   */\n  keywords?: Keyword[];\n}\n\nexport interface QueryCollectionsRequest {\n  query?: PlatformQuery;\n}\n\nexport interface PlatformQuery extends PlatformQueryPagingMethodOneOf {\n  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n  paging?: PlatformPaging;\n  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n  cursorPaging?: CursorPaging;\n  /** Filter object. */\n  filter?: Record<string, any> | null;\n  /** Sorting options. For example, `[{\"fieldName\":\"sortField1\"},{\"fieldName\":\"sortField2\",\"direction\":\"DESC\"}]`. */\n  sort?: Sorting[];\n}\n\n/** @oneof */\nexport interface PlatformQueryPagingMethodOneOf {\n  /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */\n  paging?: PlatformPaging;\n  /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */\n  cursorPaging?: CursorPaging;\n}\n\nexport interface Sorting {\n  /**\n   * Name of the field to sort by.\n   * @maxLength 512\n   */\n  fieldName?: string;\n  /** Sort order. */\n  order?: SortOrderWithLiterals;\n}\n\nexport enum SortOrder {\n  ASC = 'ASC',\n  DESC = 'DESC',\n}\n\n/** @enumType */\nexport type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';\n\nexport interface PlatformPaging {\n  /**\n   * Number of items to load.\n   * @max 100\n   */\n  limit?: number | null;\n  /** Number of items to skip in the current sort order. */\n  offset?: number | null;\n}\n\nexport interface CursorPaging {\n  /**\n   * Maximum number of items to return in the results.\n   * @max 100\n   */\n  limit?: number | null;\n  /**\n   * Pointer to the next or previous page in the list of results.\n   *\n   * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\n   * Not relevant for the first request.\n   * @maxLength 16000\n   */\n  cursor?: string | null;\n}\n\nexport interface QueryCollectionsResponse {\n  /** @maxSize 100 */\n  collections?: Collection[];\n  metadata?: PlatformPagingMetadata;\n}\n\nexport interface PlatformPagingMetadata {\n  /** The number of items returned in this response. */\n  count?: number | null;\n  /** The offset which was requested. Returned if offset paging was used. */\n  offset?: number | null;\n  /** The total number of items that match the query. Returned if offset paging was used. */\n  total?: number | null;\n  /** Cursors to navigate through result pages. Returned if cursor paging was used. */\n  cursors?: Cursors;\n}\n\nexport interface Cursors {\n  /**\n   * Cursor string pointing to the next page in the list of results.\n   * @maxLength 16000\n   */\n  next?: string | null;\n  /**\n   * Cursor pointing to the previous page in the list of results.\n   * @maxLength 16000\n   */\n  prev?: string | null;\n}\n\nexport interface GetCollectionRequest {\n  /** Requested collection ID. */\n  _id: string;\n}\n\nexport interface GetCollectionResponse {\n  collection?: Collection;\n}\n\nexport interface GetCollectionBySlugRequest {\n  /**\n   * Slug of the collection to retrieve.\n   * @minLength 1\n   * @maxLength 100\n   */\n  slug: string;\n}\n\nexport interface GetCollectionBySlugResponse {\n  /** The requested collection. */\n  collection?: Collection;\n}\n\ntype CollectionNonNullablePaths =\n  | `media.mainMedia.image.url`\n  | `media.mainMedia.image.width`\n  | `media.mainMedia.image.height`\n  | `media.mainMedia.video.files`\n  | `media.mainMedia.video.stillFrameMediaId`\n  | `media.mainMedia.mediaType`\n  | `media.mainMedia.title`\n  | `media.mainMedia._id`\n  | `media.items`\n  | `numberOfProducts`;\n\n/**\n * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n * @public\n * @fqn wix.catalog.api.v2.CollectionReadApi.QueryCollections\n */\nexport function queryCollections(): CollectionsQueryBuilder {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[0] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  return queryBuilder<\n    Collection,\n    'OFFSET',\n    QueryCollectionsRequest,\n    QueryCollectionsResponse\n  >({\n    func: async (payload: QueryCollectionsRequest) => {\n      const reqOpts =\n        ambassadorWixStoresCatalogV1Collection.queryCollections(payload);\n\n      sideEffects?.onSiteCall?.();\n      try {\n        const result = await httpClient.request(reqOpts);\n        sideEffects?.onSuccess?.(result);\n        return result;\n      } catch (err) {\n        sideEffects?.onError?.(err);\n        throw err;\n      }\n    },\n    requestTransformer: (query: QueryCollectionsRequest['query']) => {\n      const args = [query, {}] as [QueryCollectionsRequest['query'], {}];\n      return renameKeysFromSDKRequestToRESTRequest({\n        ...args?.[1],\n        query: args?.[0],\n      });\n    },\n    responseTransformer: ({ data }: HttpResponse<QueryCollectionsResponse>) => {\n      const transformedData = renameKeysFromRESTResponseToSDKResponse(\n        transformPaths(data, [])\n      );\n\n      return {\n        items: transformedData?.collections,\n        pagingMetadata: transformedData?.metadata,\n      };\n    },\n    errorTransformer: (err: unknown) => {\n      const transformedError = sdkTransformError(err, {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { query: '$[0]' },\n        singleArgumentUnchanged: false,\n      });\n\n      throw transformedError;\n    },\n    pagingMethod: 'OFFSET',\n    transformationPaths: {},\n  });\n}\n\ninterface QueryOffsetResult {\n  currentPage: number | undefined;\n  totalPages: number | undefined;\n  totalCount: number | undefined;\n  hasNext: () => boolean;\n  hasPrev: () => boolean;\n  length: number;\n  pageSize: number;\n}\n\nexport interface CollectionsQueryResult extends QueryOffsetResult {\n  items: Collection[];\n  query: CollectionsQueryBuilder;\n  next: () => Promise<CollectionsQueryResult>;\n  prev: () => Promise<CollectionsQueryResult>;\n}\n\nexport interface CollectionsQueryBuilder {\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   */\n  eq: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   */\n  ne: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   */\n  ge: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   */\n  gt: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   */\n  le: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `value`.\n   * @param value - Value to compare against.\n   */\n  lt: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `string`.\n   * @param string - String to compare against. Case-insensitive.\n   */\n  startsWith: (\n    propertyName: '_id' | 'name',\n    value: string\n  ) => CollectionsQueryBuilder;\n  /** @param propertyName - Property whose value is compared with `values`.\n   * @param values - List of values to compare against.\n   */\n  hasSome: (\n    propertyName: '_id' | 'name',\n    value: any[]\n  ) => CollectionsQueryBuilder;\n  in: (propertyName: '_id' | 'name', value: any) => CollectionsQueryBuilder;\n  exists: (\n    propertyName: '_id' | 'name',\n    value: boolean\n  ) => CollectionsQueryBuilder;\n  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n  ascending: (\n    ...propertyNames: Array<'_id' | 'name'>\n  ) => CollectionsQueryBuilder;\n  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */\n  descending: (\n    ...propertyNames: Array<'_id' | 'name'>\n  ) => CollectionsQueryBuilder;\n  /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */\n  limit: (limit: number) => CollectionsQueryBuilder;\n  /** @param skip - Number of items to skip in the query results before returning the results. */\n  skip: (skip: number) => CollectionsQueryBuilder;\n  find: () => Promise<CollectionsQueryResult>;\n}\n\n/**\n * Retrieves a collection with the provided ID.\n * @param _id - Requested collection ID.\n * @public\n * @requiredField _id\n * @fqn wix.catalog.api.v2.CollectionReadApi.GetCollection\n */\nexport async function getCollection(\n  _id: string\n): Promise<NonNullablePaths<Collection, CollectionNonNullablePaths>> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({ id: _id });\n\n  const reqOpts = ambassadorWixStoresCatalogV1Collection.getCollection(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)?.collection!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { id: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['_id']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n\n/**\n * Retrieves a collection with the provided slug.\n * @param slug - Slug of the collection to retrieve.\n * @public\n * @requiredField slug\n * @fqn wix.catalog.api.v2.CollectionReadApi.GetCollectionBySlug\n */\nexport async function getCollectionBySlug(\n  slug: string\n): Promise<\n  NonNullablePaths<\n    GetCollectionBySlugResponse,\n    {\n      [P in CollectionNonNullablePaths]: `collection.${P}`;\n    }[CollectionNonNullablePaths]\n  >\n> {\n  // @ts-ignore\n  const { httpClient, sideEffects } = arguments[1] as {\n    httpClient: HttpClient;\n    sideEffects?: any;\n  };\n\n  const payload = renameKeysFromSDKRequestToRESTRequest({ slug: slug });\n\n  const reqOpts =\n    ambassadorWixStoresCatalogV1Collection.getCollectionBySlug(payload);\n\n  sideEffects?.onSiteCall?.();\n  try {\n    const result = await httpClient.request(reqOpts);\n    sideEffects?.onSuccess?.(result);\n\n    return renameKeysFromRESTResponseToSDKResponse(result.data)!;\n  } catch (err: any) {\n    const transformedError = sdkTransformError(\n      err,\n      {\n        spreadPathsToArguments: {},\n        explicitPathsToArguments: { slug: '$[0]' },\n        singleArgumentUnchanged: false,\n      },\n      ['slug']\n    );\n    sideEffects?.onError?.(err);\n\n    throw transformedError;\n  }\n}\n","import { toURLSearchParams } from '@wix/sdk-runtime/rest-modules';\nimport { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';\nimport { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';\nimport { resolveUrl } from '@wix/sdk-runtime/rest-modules';\nimport { ResolveUrlOpts } from '@wix/sdk-runtime/rest-modules';\nimport { RequestOptionsFactory } from '@wix/sdk-types';\n\nfunction resolveWixCatalogApiV2CollectionReadApiUrl(\n  opts: Omit<ResolveUrlOpts, 'domainToMappings'>\n) {\n  const domainToMappings = {\n    'api._api_base_domain_': [\n      {\n        srcPath: '/wix-ecommerce-catalog-reader-web',\n        destPath: '',\n      },\n    ],\n    'manage._base_domain_': [\n      {\n        srcPath: '/wix-ecommerce-catalog-reader-web',\n        destPath: '',\n      },\n    ],\n    'www.wixapis.com': [\n      {\n        srcPath: '/stores-reader/v2/collections',\n        destPath: '/v2/collections',\n      },\n      {\n        srcPath: '/stores-reader/v2/inventoryItems',\n        destPath: '/v2/inventoryItems',\n      },\n    ],\n    'www._base_domain_': [\n      {\n        srcPath: '/wix-ecommerce-catalog-reader-web',\n        destPath: '',\n      },\n    ],\n    'editor._base_domain_': [\n      {\n        srcPath: '/_api/wix-ecommerce-catalog-reader-web',\n        destPath: '',\n      },\n    ],\n    'blocks._base_domain_': [\n      {\n        srcPath: '/_api/wix-ecommerce-catalog-reader-web',\n        destPath: '',\n      },\n    ],\n    'create.editorx': [\n      {\n        srcPath: '/_api/wix-ecommerce-catalog-reader-web',\n        destPath: '',\n      },\n    ],\n    _: [\n      {\n        srcPath: '/stores-reader/v2/inventoryItems',\n        destPath: '/v2/inventoryItems',\n      },\n      {\n        srcPath: '/stores-reader/v2/collections',\n        destPath: '/v2/collections',\n      },\n    ],\n  };\n\n  return resolveUrl(Object.assign(opts, { domainToMappings }));\n}\n\nconst PACKAGE_NAME = '@wix/auto_sdk_stores_collections';\n\n/**\n * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.\n * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.\n */\nexport function queryCollections(payload: object): RequestOptionsFactory<any> {\n  function __queryCollections({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.stores.catalog.v1.collection',\n      method: 'POST' as any,\n      methodFqn: 'wix.catalog.api.v2.CollectionReadApi.QueryCollections',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCatalogApiV2CollectionReadApiUrl({\n        protoPath: '/v2/collections/query',\n        data: payload,\n        host,\n      }),\n      data: payload,\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'collections.lastUpdated' }],\n          },\n        ]),\n      fallback: [\n        {\n          method: 'POST' as any,\n          url: resolveWixCatalogApiV2CollectionReadApiUrl({\n            protoPath: '/v2/collections/query',\n            data: payload,\n            host,\n          }),\n          data: payload,\n        },\n      ],\n    };\n\n    return metadata;\n  }\n\n  return __queryCollections;\n}\n\n/** Retrieves a collection with the provided ID. */\nexport function getCollection(payload: object): RequestOptionsFactory<any> {\n  function __getCollection({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.stores.catalog.v1.collection',\n      method: 'GET' as any,\n      methodFqn: 'wix.catalog.api.v2.CollectionReadApi.GetCollection',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCatalogApiV2CollectionReadApiUrl({\n        protoPath: '/v2/collections/{id}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'collection.lastUpdated' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getCollection;\n}\n\n/** Retrieves a collection with the provided slug. */\nexport function getCollectionBySlug(\n  payload: object\n): RequestOptionsFactory<any> {\n  function __getCollectionBySlug({ host }: any) {\n    const metadata = {\n      entityFqdn: 'wix.stores.catalog.v1.collection',\n      method: 'GET' as any,\n      methodFqn: 'wix.catalog.api.v2.CollectionReadApi.GetCollectionBySlug',\n      packageName: PACKAGE_NAME,\n      url: resolveWixCatalogApiV2CollectionReadApiUrl({\n        protoPath: '/v2/collections/slug/{slug}',\n        data: payload,\n        host,\n      }),\n      params: toURLSearchParams(payload),\n      transformResponse: (payload: any) =>\n        transformPaths(payload, [\n          {\n            transformFn: transformRESTTimestampToSDKTimestamp,\n            paths: [{ path: 'collection.lastUpdated' }],\n          },\n        ]),\n    };\n\n    return metadata;\n  }\n\n  return __getCollectionBySlug;\n}\n"],"mappings":";AAAA,SAAS,kBAAkB,yBAAyB;AACpD,SAAS,oBAAoB;AAC7B;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACLP,SAAS,yBAAyB;AAClC,SAAS,4CAA4C;AACrD,SAAS,sBAAsB;AAC/B,SAAS,kBAAkB;AAI3B,SAAS,2CACP,MACA;AACA,QAAM,mBAAmB;AAAA,IACvB,yBAAyB;AAAA,MACvB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,mBAAmB;AAAA,MACjB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,qBAAqB;AAAA,MACnB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,wBAAwB;AAAA,MACtB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,kBAAkB;AAAA,MAChB;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,IACA,GAAG;AAAA,MACD;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,MACA;AAAA,QACE,SAAS;AAAA,QACT,UAAU;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,SAAO,WAAW,OAAO,OAAO,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC7D;AAEA,IAAM,eAAe;AAMd,SAAS,iBAAiB,SAA6C;AAC5E,WAAS,mBAAmB,EAAE,KAAK,GAAQ;AACzC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,2CAA2C;AAAA,QAC9C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,MAAM;AAAA,MACN,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,0BAA0B,CAAC;AAAA,QAC7C;AAAA,MACF,CAAC;AAAA,MACH,UAAU;AAAA,QACR;AAAA,UACE,QAAQ;AAAA,UACR,KAAK,2CAA2C;AAAA,YAC9C,WAAW;AAAA,YACX,MAAM;AAAA,YACN;AAAA,UACF,CAAC;AAAA,UACD,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,cAAc,SAA6C;AACzE,WAAS,gBAAgB,EAAE,KAAK,GAAQ;AACtC,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,2CAA2C;AAAA,QAC9C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;AAGO,SAAS,oBACd,SAC4B;AAC5B,WAAS,sBAAsB,EAAE,KAAK,GAAQ;AAC5C,UAAM,WAAW;AAAA,MACf,YAAY;AAAA,MACZ,QAAQ;AAAA,MACR,WAAW;AAAA,MACX,aAAa;AAAA,MACb,KAAK,2CAA2C;AAAA,QAC9C,WAAW;AAAA,QACX,MAAM;AAAA,QACN;AAAA,MACF,CAAC;AAAA,MACD,QAAQ,kBAAkB,OAAO;AAAA,MACjC,mBAAmB,CAACA,aAClB,eAAeA,UAAS;AAAA,QACtB;AAAA,UACE,aAAa;AAAA,UACb,OAAO,CAAC,EAAE,MAAM,yBAAyB,CAAC;AAAA,QAC5C;AAAA,MACF,CAAC;AAAA,IACL;AAEA,WAAO;AAAA,EACT;AAEA,SAAO;AACT;;;ADtKA,SAAS,kBAAAC,uBAAsB;AA6FxB,IAAK,gBAAL,kBAAKC,mBAAL;AACL,EAAAA,eAAA,iCAA8B;AAE9B,EAAAA,eAAA,WAAQ;AAER,EAAAA,eAAA,WAAQ;AAER,EAAAA,eAAA,WAAQ;AAER,EAAAA,eAAA,cAAW;AAEX,EAAAA,eAAA,SAAM;AAXI,SAAAA;AAAA,GAAA;AA8HL,IAAK,YAAL,kBAAKC,eAAL;AACL,EAAAA,WAAA,SAAM;AACN,EAAAA,WAAA,UAAO;AAFG,SAAAA;AAAA,GAAA;AAyGL,SAASC,oBAA4C;AAE1D,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,SAAO,aAKL;AAAA,IACA,MAAM,OAAO,YAAqC;AAChD,YAAM,UACmC,iBAAiB,OAAO;AAEjE,mBAAa,aAAa;AAC1B,UAAI;AACF,cAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,qBAAa,YAAY,MAAM;AAC/B,eAAO;AAAA,MACT,SAAS,KAAK;AACZ,qBAAa,UAAU,GAAG;AAC1B,cAAM;AAAA,MACR;AAAA,IACF;AAAA,IACA,oBAAoB,CAAC,UAA4C;AAC/D,YAAM,OAAO,CAAC,OAAO,CAAC,CAAC;AACvB,aAAO,sCAAsC;AAAA,QAC3C,GAAG,OAAO,CAAC;AAAA,QACX,OAAO,OAAO,CAAC;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,IACA,qBAAqB,CAAC,EAAE,KAAK,MAA8C;AACzE,YAAM,kBAAkB;AAAA,QACtBH,gBAAe,MAAM,CAAC,CAAC;AAAA,MACzB;AAEA,aAAO;AAAA,QACL,OAAO,iBAAiB;AAAA,QACxB,gBAAgB,iBAAiB;AAAA,MACnC;AAAA,IACF;AAAA,IACA,kBAAkB,CAAC,QAAiB;AAClC,YAAM,mBAAmB,kBAAkB,KAAK;AAAA,QAC9C,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,OAAO,OAAO;AAAA,QAC1C,yBAAyB;AAAA,MAC3B,CAAC;AAED,YAAM;AAAA,IACR;AAAA,IACA,cAAc;AAAA,IACd,qBAAqB,CAAC;AAAA,EACxB,CAAC;AACH;AAqFA,eAAsBI,eACpB,KACmE;AAEnE,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,EAAE,IAAI,IAAI,CAAC;AAEjE,QAAM,UAAiD,cAAc,OAAO;AAE5E,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI,GAAG;AAAA,EAC/D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,IAAI,OAAO;AAAA,QACvC,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,KAAK;AAAA,IACR;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;AASA,eAAsBC,qBACpB,MAQA;AAEA,QAAM,EAAE,YAAY,YAAY,IAAI,UAAU,CAAC;AAK/C,QAAM,UAAU,sCAAsC,EAAE,KAAW,CAAC;AAEpE,QAAM,UACmC,oBAAoB,OAAO;AAEpE,eAAa,aAAa;AAC1B,MAAI;AACF,UAAM,SAAS,MAAM,WAAW,QAAQ,OAAO;AAC/C,iBAAa,YAAY,MAAM;AAE/B,WAAO,wCAAwC,OAAO,IAAI;AAAA,EAC5D,SAAS,KAAU;AACjB,UAAM,mBAAmB;AAAA,MACvB;AAAA,MACA;AAAA,QACE,wBAAwB,CAAC;AAAA,QACzB,0BAA0B,EAAE,MAAM,OAAO;AAAA,QACzC,yBAAyB;AAAA,MAC3B;AAAA,MACA,CAAC,MAAM;AAAA,IACT;AACA,iBAAa,UAAU,GAAG;AAE1B,UAAM;AAAA,EACR;AACF;","names":["payload","transformPaths","MediaItemType","SortOrder","queryCollections","getCollection","getCollectionBySlug"]}

package/build/internal/es/meta.d.mts

@@ -1,4 +1,5 @@
-import { Q as QueryCollectionsRequest$1, m as QueryCollectionsResponse$1, p as GetCollectionRequest$1, q as GetCollectionResponse$1, r as GetCollectionBySlugRequest$1, G as GetCollectionBySlugResponse$1 } from './stores-catalog-v1-collection-collections.universal-BdGGTv5j.mjs';
+import { QueryCollectionsRequest as QueryCollectionsRequest$1, QueryCollectionsResponse as QueryCollectionsResponse$1, GetCollectionRequest as GetCollectionRequest$1, GetCollectionResponse as GetCollectionResponse$1, GetCollectionBySlugRequest as GetCollectionBySlugRequest$1, GetCollectionBySlugResponse as GetCollectionBySlugResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
 
 interface Collection {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_stores_collections",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -49,5 +49,5 @@
       "fqdn": "wix.stores.catalog.v1.collection"
     }
   },
-  "falconPackageHash": "ab27817c1cc92638e9348aa26b0dfafa8a3807cae4129a5f3936d991"
+  "falconPackageHash": "08deb8d60089cd742863fb714118f8045a07d7300a0888987d6d6d4e"
 }