@wix/stores 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export * as collections from './src/stores-poc-v1-collection.public';
+export * as products from './src/stores-poc-v1-product.public';

package/build/cjs/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.products = exports.collections = void 0;
+exports.collections = __importStar(require("./src/stores-poc-v1-collection.public"));
+exports.products = __importStar(require("./src/stores-poc-v1-product.public"));
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,qFAAqE;AACrE,+EAA+D"}

package/build/cjs/src/stores-poc-v1-collection.http.d.ts

@@ -0,0 +1,4 @@
+import { RequestOptionsFactory } from '@wix/sdk-types';
+import { GetCollectionRequest, GetCollectionResponse, QueryCollectionsRequest, QueryCollectionsResponse } from './stores-poc-v1-collection.types';
+export declare function getCollection(payload: GetCollectionRequest): RequestOptionsFactory<GetCollectionResponse>;
+export declare function queryCollections(payload: QueryCollectionsRequest): RequestOptionsFactory<QueryCollectionsResponse>;

package/build/cjs/src/stores-poc-v1-collection.http.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryCollections = exports.getCollection = void 0;
+const metro_runtime_1 = require("@wix/metro-runtime");
+const ambassador_1 = require("@wix/metro-runtime/ambassador");
+const metro_runtime_2 = require("@wix/metro-runtime");
+const _getCollectionRequest = {};
+const _getCollectionResponse = {};
+const _queryCollectionsRequest = {};
+const _queryCollectionsResponse = {};
+function resolveWixCoreservicesMetroinspectorV1CollectionsPocCollectionsPocServiceUrl(opts) {
+    const domainToMappings = {};
+    return metro_runtime_2.resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+function getCollection(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_getCollectionRequest, {});
+    const { fromJSON: fromRes } = ambassador_1.serializer(_getCollectionResponse, {});
+    function __getCollection({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            method: 'GET',
+            url: resolveWixCoreservicesMetroinspectorV1CollectionsPocCollectionsPocServiceUrl({
+                protoPath: '/v1/collections/{collectionId}',
+                data: serializedData,
+                host,
+            }),
+            params: metro_runtime_1.toURLSearchParams(serializedData),
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __getCollection.fromReq = fromReq;
+    return __getCollection;
+}
+exports.getCollection = getCollection;
+function queryCollections(payload) {
+    const { toJSON: toReq, fromJSON: fromReq } = ambassador_1.serializer(_queryCollectionsRequest, {});
+    const { fromJSON: fromRes } = ambassador_1.serializer(_queryCollectionsResponse, {});
+    function __queryCollections({ host }) {
+        const serializedData = toReq(payload);
+        const metadata = {
+            method: 'POST',
+            url: resolveWixCoreservicesMetroinspectorV1CollectionsPocCollectionsPocServiceUrl({ protoPath: '/v1/collections/query', data: serializedData, host }),
+            data: serializedData,
+            transformResponse: fromRes,
+        };
+        return metadata;
+    }
+    __queryCollections.fromReq = fromReq;
+    return __queryCollections;
+}
+exports.queryCollections = queryCollections;
+//# sourceMappingURL=stores-poc-v1-collection.http.js.map

package/build/cjs/src/stores-poc-v1-collection.http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-poc-v1-collection.http.js","sourceRoot":"","sources":["../../../src/stores-poc-v1-collection.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAUhD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAErC,SAAS,4EAA4E,CACnF,IAA8C;IAE9C,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAE5B,OAAO,0BAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAErE,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,KAAY;YACpB,GAAG,EAAE,4EAA4E,CAC/E;gBACE,SAAS,EAAE,gCAAgC;gBAC3C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CACF;YACD,MAAM,EAAE,iCAAiB,CAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AA9BD,sCA8BC;AAED,SAAgB,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,uBAAU,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAExE,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,MAAa;YACrB,GAAG,EAAE,4EAA4E,CAC/E,EAAE,SAAS,EAAE,uBAAuB,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,CACnE;YACD,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AA1BD,4CA0BC"}

package/build/cjs/src/stores-poc-v1-collection.public.d.ts

@@ -0,0 +1,6 @@
+import { HttpClient } from '@wix/sdk-types';
+import { GetCollectionOptions } from './stores-poc-v1-collection.universal';
+export declare function getCollection(httpClient: HttpClient): (collectionId: string, options?: GetCollectionOptions | undefined) => Promise<import("./stores-poc-v1-collection.universal").Collection>;
+export declare function queryCollections(httpClient: HttpClient): () => import("./stores-poc-v1-collection.universal").CollectionsQueryBuilder;
+export { MediaItemType, SortOrder } from './stores-poc-v1-collection.universal';
+export { Collection, Media, MediaItem, MediaItemItemOneOf, MediaItemUrlAndSize, MediaItemVideo, GetCollectionRequest, GetCollectionResponse, QueryCollectionsRequest, PlatformQuery, PlatformQueryPagingMethodOneOf, Sorting, PlatformPaging, QueryCollectionsResponse, PlatformPagingMetadata, Cursors, GetCollectionOptions, CollectionsQueryResult, CollectionsQueryBuilder, } from './stores-poc-v1-collection.universal';

package/build/cjs/src/stores-poc-v1-collection.public.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.MediaItemType = exports.queryCollections = exports.getCollection = void 0;
+const stores_poc_v1_collection_universal_1 = require("./stores-poc-v1-collection.universal");
+function getCollection(httpClient) {
+    return (collectionId, options) => stores_poc_v1_collection_universal_1.getCollection(collectionId, options, 
+    // @ts-ignore
+    { httpClient });
+}
+exports.getCollection = getCollection;
+function queryCollections(httpClient) {
+    return () => stores_poc_v1_collection_universal_1.queryCollections(
+    // @ts-ignore
+    { httpClient });
+}
+exports.queryCollections = queryCollections;
+var stores_poc_v1_collection_universal_2 = require("./stores-poc-v1-collection.universal");
+Object.defineProperty(exports, "MediaItemType", { enumerable: true, get: function () { return stores_poc_v1_collection_universal_2.MediaItemType; } });
+Object.defineProperty(exports, "SortOrder", { enumerable: true, get: function () { return stores_poc_v1_collection_universal_2.SortOrder; } });
+//# sourceMappingURL=stores-poc-v1-collection.public.js.map

package/build/cjs/src/stores-poc-v1-collection.public.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-poc-v1-collection.public.js","sourceRoot":"","sources":["../../../src/stores-poc-v1-collection.public.ts"],"names":[],"mappings":";;;AACA,6FAI8C;AAE9C,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,YAAoB,EAAE,OAA8B,EAAE,EAAE,CAC9D,kDAAsB,CACpB,YAAY,EACZ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,sCAQC;AAED,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,GAAG,EAAE,CACV,qDAAyB;IACvB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,4CAMC;AAED,2FAAgF;AAAvE,mIAAA,aAAa,OAAA;AAAE,+HAAA,SAAS,OAAA"}

package/build/cjs/src/stores-poc-v1-collection.types.d.ts

@@ -0,0 +1,148 @@
+export interface Collection {
+    /**
+     * Collection ID (generated automatically by the catalog)
+     * @readonly
+     */
+    id?: string | null;
+    /** Collection name */
+    name?: string | null;
+    /**
+     * Media items (images, videos etc) associated with this collection. Read only.
+     * @readonly
+     */
+    media?: Media;
+    /**
+     * Number of products in the collection. Read only.
+     * @readonly
+     */
+    numberOfProducts?: number;
+    /** Collection description. The description length without HTML must not exceed 2000 characters (10K includes HTML) */
+    description?: string | null;
+    /** Collection slug */
+    slug?: string | null;
+    /** Collection visibility. Only impacts dynamic pages, no impact on static pages */
+    visible?: boolean | null;
+}
+export interface Media {
+    /** Primary media (image, video etc) associated with this product. */
+    mainMedia?: MediaItem;
+    /** Media (images, videos etc) associated with this product. */
+    items?: MediaItem[];
+}
+export interface MediaItem extends MediaItemItemOneOf {
+    /** Media item thumbnail details. */
+    thumbnail?: MediaItemUrlAndSize;
+    /** Media item type (image, video, etc.). */
+    mediaType?: MediaItemType;
+    /** Media item title. */
+    title?: string;
+    /** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
+    id?: string;
+    /** Image data (URL, size). */
+    image?: MediaItemUrlAndSize;
+    /** Video data (URL, size). */
+    video?: MediaItemVideo;
+}
+/** @oneof */
+export interface MediaItemItemOneOf {
+    /** Image data (URL, size). */
+    image?: MediaItemUrlAndSize;
+    /** Video data (URL, size). */
+    video?: MediaItemVideo;
+}
+export interface MediaItemUrlAndSize {
+    /** Media item URL. */
+    url?: string;
+    /** Media item width. */
+    width?: number;
+    /** Media item height. */
+    height?: number;
+    /** Media format (mp4, png, etc.). */
+    format?: string | null;
+    /** Alt text. This text will be shown in case the image is not available. */
+    altText?: string | null;
+}
+export declare enum MediaItemType {
+    unspecified_media_item_type = "unspecified_media_item_type",
+    image = "image",
+    video = "video",
+    audio = "audio",
+    document = "document",
+    zip = "zip"
+}
+export interface MediaItemVideo {
+    /** Data (URL, size) about each resolution for which this video is available. */
+    files?: MediaItemUrlAndSize[];
+    /** 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"`. */
+    stillFrameMediaId?: string;
+}
+export interface GetCollectionRequest {
+    /** Requested collection ID. */
+    collectionId: string;
+    /**
+     * Whether to return the `collection.numberOfProducts` field in the response.
+     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
+     */
+    includeNumberOfProducts?: boolean;
+    /** Include description in response. When False, description will be null */
+    includeDescription?: boolean;
+}
+export interface GetCollectionResponse {
+    collection?: Collection;
+}
+export interface QueryCollectionsRequest {
+    query?: PlatformQuery;
+    /** Whether number of products should be included in the response. */
+    includeNumberOfProducts?: boolean;
+    /** Include description in response. When False, description will be null */
+    includeDescription?: boolean;
+}
+export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+    /** Filter object. */
+    filter?: Record<string, any> | null;
+    /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
+    sort?: Sorting[];
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: PlatformPaging;
+}
+/** @oneof */
+export interface PlatformQueryPagingMethodOneOf {
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: PlatformPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface PlatformPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryCollectionsResponse {
+    collections?: Collection[];
+    metadata?: PlatformPagingMetadata;
+}
+export interface PlatformPagingMetadata {
+    /** The number of items returned in this response. */
+    count?: number | null;
+    /** The offset which was requested. Returned if offset paging was used. */
+    offset?: number | null;
+    /** The total number of items that match the query. Returned if offset paging was used. */
+    total?: number | null;
+    /** Cursors to navigate through result pages. Returned if cursor paging was used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}

package/build/cjs/src/stores-poc-v1-collection.types.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortOrder = exports.MediaItemType = void 0;
+var MediaItemType;
+(function (MediaItemType) {
+    MediaItemType["unspecified_media_item_type"] = "unspecified_media_item_type";
+    MediaItemType["image"] = "image";
+    MediaItemType["video"] = "video";
+    MediaItemType["audio"] = "audio";
+    MediaItemType["document"] = "document";
+    MediaItemType["zip"] = "zip";
+})(MediaItemType = exports.MediaItemType || (exports.MediaItemType = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+//# sourceMappingURL=stores-poc-v1-collection.types.js.map

package/build/cjs/src/stores-poc-v1-collection.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stores-poc-v1-collection.types.js","sourceRoot":"","sources":["../../../src/stores-poc-v1-collection.types.ts"],"names":[],"mappings":";;;AAqEA,IAAY,aAOX;AAPD,WAAY,aAAa;IACvB,4EAA2D,CAAA;IAC3D,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,sCAAqB,CAAA;IACrB,4BAAW,CAAA;AACb,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB;AAuDD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB"}

package/build/cjs/src/stores-poc-v1-collection.universal.d.ts

@@ -0,0 +1,210 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Collection {
+    /**
+     * Collection ID (generated automatically by the catalog)
+     * @readonly
+     */
+    _id?: string | null;
+    /** Collection name */
+    name?: string | null;
+    /**
+     * Media items (images, videos etc) associated with this collection. Read only.
+     * @readonly
+     */
+    media?: Media;
+    /**
+     * Number of products in the collection. Read only.
+     * @readonly
+     */
+    numberOfProducts?: number;
+    /** Collection description. The description length without HTML must not exceed 2000 characters (10K includes HTML) */
+    description?: string | null;
+    /** Collection slug */
+    slug?: string | null;
+    /** Collection visibility. Only impacts dynamic pages, no impact on static pages */
+    visible?: boolean | null;
+}
+export interface Media {
+    /** Primary media (image, video etc) associated with this product. */
+    mainMedia?: MediaItem;
+    /** Media (images, videos etc) associated with this product. */
+    items?: MediaItem[];
+}
+export interface MediaItem extends MediaItemItemOneOf {
+    /** Media item thumbnail details. */
+    thumbnail?: MediaItemUrlAndSize;
+    /** Media item type (image, video, etc.). */
+    mediaType?: MediaItemType;
+    /** Media item title. */
+    title?: string;
+    /** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
+    _id?: string;
+    /** Image data (URL, size). */
+    image?: MediaItemUrlAndSize;
+    /** Video data (URL, size). */
+    video?: MediaItemVideo;
+}
+/** @oneof */
+export interface MediaItemItemOneOf {
+    /** Image data (URL, size). */
+    image?: MediaItemUrlAndSize;
+    /** Video data (URL, size). */
+    video?: MediaItemVideo;
+}
+export interface MediaItemUrlAndSize {
+    /** Media item URL. */
+    url?: string;
+    /** Media item width. */
+    width?: number;
+    /** Media item height. */
+    height?: number;
+    /** Media format (mp4, png, etc.). */
+    format?: string | null;
+    /** Alt text. This text will be shown in case the image is not available. */
+    altText?: string | null;
+}
+export declare enum MediaItemType {
+    unspecified_media_item_type = "unspecified_media_item_type",
+    image = "image",
+    video = "video",
+    audio = "audio",
+    document = "document",
+    zip = "zip"
+}
+export interface MediaItemVideo {
+    /** Data (URL, size) about each resolution for which this video is available. */
+    files?: MediaItemUrlAndSize[];
+    /** 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"`. */
+    stillFrameMediaId?: string;
+}
+export interface GetCollectionRequest {
+    /** Requested collection ID. */
+    collectionId: string;
+    /**
+     * Whether to return the `collection.numberOfProducts` field in the response.
+     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
+     */
+    includeNumberOfProducts?: boolean;
+    /** Include description in response. When False, description will be null */
+    includeDescription?: boolean;
+}
+export interface GetCollectionResponse {
+    collection?: Collection;
+}
+export interface QueryCollectionsRequest {
+    query?: PlatformQuery;
+    /** Whether number of products should be included in the response. */
+    includeNumberOfProducts?: boolean;
+    /** Include description in response. When False, description will be null */
+    includeDescription?: boolean;
+}
+export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+    /** Filter object. */
+    filter?: Record<string, any> | null;
+    /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
+    sort?: Sorting[];
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: PlatformPaging;
+}
+/** @oneof */
+export interface PlatformQueryPagingMethodOneOf {
+    /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
+    paging?: PlatformPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface PlatformPaging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryCollectionsResponse {
+    collections?: Collection[];
+    metadata?: PlatformPagingMetadata;
+}
+export interface PlatformPagingMetadata {
+    /** The number of items returned in this response. */
+    count?: number | null;
+    /** The offset which was requested. Returned if offset paging was used. */
+    offset?: number | null;
+    /** The total number of items that match the query. Returned if offset paging was used. */
+    total?: number | null;
+    /** Cursors to navigate through result pages. Returned if cursor paging was used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+/** @param collectionId - Requested collection ID.
+ * @public
+ * @requiredField collectionId
+ */
+export declare function getCollection(collectionId: string, options?: GetCollectionOptions): Promise<Collection>;
+export interface GetCollectionOptions {
+    /**
+     * Whether to return the `collection.numberOfProducts` field in the response.
+     * Defaults to false, in which case the value of `collection.numberOfProducts` will be 0.
+     */
+    includeNumberOfProducts?: boolean;
+    /** Include description in response. When False, description will be null */
+    includeDescription?: boolean;
+}
+/** @public */
+export declare function queryCollections(): CollectionsQueryBuilder;
+interface QueryCursorResult {
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface CollectionsQueryResult extends QueryCursorResult {
+    items: Collection[];
+    query: CollectionsQueryBuilder;
+    next: () => Promise<CollectionsQueryResult>;
+    prev: () => Promise<CollectionsQueryResult>;
+}
+export interface CollectionsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: string, value: any) => CollectionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: string, value: any) => CollectionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     */
+    startsWith: (propertyName: string, value: string) => CollectionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     */
+    hasSome: (propertyName: string, value: any[]) => CollectionsQueryBuilder;
+    in: (propertyName: string, value: any) => CollectionsQueryBuilder;
+    exists: (propertyName: string, value: boolean) => CollectionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: string[]) => CollectionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: string[]) => CollectionsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => CollectionsQueryBuilder;
+    find: () => Promise<CollectionsQueryResult>;
+}
+export {};

package/build/cjs/src/stores-poc-v1-collection.universal.js

@@ -0,0 +1,161 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryCollections = exports.getCollection = exports.SortOrder = exports.MediaItemType = exports.__debug = void 0;
+const velo_1 = require("@wix/metro-runtime/velo");
+const ambassadorWixStoresPocV1Collection = __importStar(require("./stores-poc-v1-collection.http"));
+// @ts-ignore
+const motion_edm_autogen_query_wrapper_1 = require("@wix/motion-edm-autogen-query-wrapper");
+let __verbose = false;
+function __log(...args) {
+    __verbose && console.log(...args);
+}
+function __inspect(obj) {
+    return obj;
+}
+exports.__debug = {
+    verboseLogging: {
+        on: () => (__verbose = true),
+        off: () => (__verbose = false),
+    },
+};
+const _toVeloEntity = '$';
+const _fromVeloEntity = '$';
+var MediaItemType;
+(function (MediaItemType) {
+    MediaItemType["unspecified_media_item_type"] = "unspecified_media_item_type";
+    MediaItemType["image"] = "image";
+    MediaItemType["video"] = "video";
+    MediaItemType["audio"] = "audio";
+    MediaItemType["document"] = "document";
+    MediaItemType["zip"] = "zip";
+})(MediaItemType = exports.MediaItemType || (exports.MediaItemType = {}));
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASC"] = "ASC";
+    SortOrder["DESC"] = "DESC";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+const _getCollectionRequest = {};
+const _getCollectionResponse = {};
+const _queryCollectionsRequest = {};
+const _queryCollectionsResponse = {};
+/** @param collectionId - Requested collection ID.
+ * @public
+ * @requiredField collectionId
+ */
+function getCollection(collectionId, options) {
+    return __awaiter(this, arguments, void 0, function* () {
+        const requestTransformation = {
+            collectionId: '$[0]',
+            includeNumberOfProducts: '$[1].includeNumberOfProducts',
+            includeDescription: '$[1].includeDescription',
+        };
+        const responseTransformation = '$.collection';
+        // @ts-ignore
+        const httpClient = arguments[2].httpClient;
+        const { toAmbassadorRequest } = velo_1.serializer({
+            rootSchema: _getCollectionRequest,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [],
+                transformation: _fromVeloEntity,
+            },
+            customTransformation: requestTransformation,
+        });
+        const { fromJSON } = velo_1.serializer({
+            rootSchema: _getCollectionResponse,
+            depSchemas: {},
+            fqdnTransformation: {
+                paths: [...['collection']],
+                transformation: _toVeloEntity,
+            },
+            customTransformation: responseTransformation,
+        });
+        const payload = toAmbassadorRequest([collectionId, options]);
+        const reqOpts = ambassadorWixStoresPocV1Collection.getCollection(payload);
+        __log(`"GetCollection" sending request with: ${__inspect(reqOpts)}`);
+        try {
+            const { data } = yield httpClient.request(reqOpts);
+            return fromJSON(data);
+        }
+        catch (err) {
+            const transformedError = velo_1.transformError(err, requestTransformation, [
+                'collectionId',
+                'options',
+            ]);
+            throw transformedError;
+        }
+    });
+}
+exports.getCollection = getCollection;
+/** @public */
+function queryCollections() {
+    const requestTransformation = { '*': '$[1]', query: '$[0]' };
+    const responseTransformation = {
+        items: '$.collections',
+        pagingMetadata: '$.metadata',
+    };
+    // @ts-ignore
+    const httpClient = arguments[0].httpClient;
+    const { toAmbassadorRequest } = velo_1.serializer({
+        rootSchema: _queryCollectionsRequest,
+        depSchemas: {},
+        fqdnTransformation: {
+            paths: [],
+            transformation: _fromVeloEntity,
+        },
+        customTransformation: requestTransformation,
+    });
+    const { fromJSON } = velo_1.serializer({
+        rootSchema: _queryCollectionsResponse,
+        depSchemas: {},
+        fqdnTransformation: {
+            paths: [...['Array#collections']],
+            transformation: _toVeloEntity,
+        },
+        customTransformation: responseTransformation,
+    });
+    return motion_edm_autogen_query_wrapper_1.wrapWithQueryBuilder({
+        func: (payload) => {
+            const reqOpts = ambassadorWixStoresPocV1Collection.queryCollections(payload);
+            return httpClient.request(reqOpts);
+        },
+        requestTransformer: (...args) => toAmbassadorRequest(args),
+        responseTransformer: ({ data }) => fromJSON(data),
+        errorTransformer: (err) => {
+            const transformedError = velo_1.transformError(err, requestTransformation);
+            throw transformedError;
+        },
+        pagingMethod: 'CURSOR',
+        transformationPaths: velo_1.resolveQueryFieldsTransformationPaths(_toVeloEntity),
+    })({ cursorWithEmptyFilterAndSort: true });
+}
+exports.queryCollections = queryCollections;
+//# sourceMappingURL=stores-poc-v1-collection.universal.js.map