npm - @wix/auto_sdk_stores_collections - Versions diffs - 1.0.9 → 1.0.11 - Mend

@wix/auto_sdk_stores_collections 1.0.9 → 1.0.11

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

Files changed (130) hide show

package/build/internal/{es/src/stores-catalog-v1-collection-collections.universal.d.ts → stores-catalog-v1-collection-collections.universal-BdGGTv5j.d.ts} RENAMED Viewed

@@ -1,5 +1,4 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-export interface Collection {
+interface Collection {
     /**
      * Collection ID (generated automatically by the catalog).
      * @minLength 35
@@ -43,13 +42,13 @@ export interface Collection {
      */
     lastUpdated?: Date | null;
 }
-export interface Media {
+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 {
+interface MediaItem extends MediaItemItemOneOf {
     /** Image data (URL, size). */
     image?: MediaItemUrlAndSize;
     /** Video data (URL, size). */
@@ -64,13 +63,13 @@ export interface MediaItem extends MediaItemItemOneOf {
     _id?: string;
 }
 /** @oneof */
-export interface MediaItemItemOneOf {
+interface MediaItemItemOneOf {
     /** Image data (URL, size). */
     image?: MediaItemUrlAndSize;
     /** Video data (URL, size). */
     video?: MediaItemVideo;
 }
-export interface MediaItemUrlAndSize {
+interface MediaItemUrlAndSize {
     /**
      * Media item URL.
      * @format WEB_URL
@@ -85,7 +84,7 @@ export interface MediaItemUrlAndSize {
     /** Alt text. This text will be shown in case the image is not available. */
     altText?: string | null;
 }
-export declare enum MediaItemType {
+declare enum MediaItemType {
     unspecified_media_item_type = "unspecified_media_item_type",
     /** Image media type. */
     image = "image",
@@ -99,8 +98,8 @@ export declare enum MediaItemType {
     zip = "zip"
 }
 /** @enumType */
-export type MediaItemTypeWithLiterals = MediaItemType | 'unspecified_media_item_type' | 'image' | 'video' | 'audio' | 'document' | 'zip';
-export interface MediaItemVideo {
+type MediaItemTypeWithLiterals = MediaItemType | 'unspecified_media_item_type' | 'image' | 'video' | 'audio' | 'document' | 'zip';
+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"`. */
@@ -111,13 +110,13 @@ export interface MediaItemVideo {
  * The search engines use this information for ranking purposes, or to display snippets in the search results.
  * 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.
  */
-export interface SeoSchema {
+interface SeoSchema {
     /** SEO tag information. */
     tags?: Tag[];
     /** SEO general settings. */
     settings?: Settings;
 }
-export interface Keyword {
+interface Keyword {
     /** Keyword value. */
     term?: string;
     /** Whether the keyword is the main focus keyword. */
@@ -128,7 +127,7 @@ export interface Keyword {
      */
     origin?: string | null;
 }
-export interface Tag {
+interface Tag {
     /**
      * SEO tag type.
      *
@@ -150,7 +149,7 @@ export interface Tag {
     /** Whether the tag is disabled. */
     disabled?: boolean;
 }
-export interface Settings {
+interface Settings {
     /**
      * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
      *
@@ -164,10 +163,10 @@ export interface Settings {
      */
     keywords?: Keyword[];
 }
-export interface QueryCollectionsRequest {
+interface QueryCollectionsRequest {
     query?: PlatformQuery;
 }
-export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
     /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
@@ -178,13 +177,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface PlatformQueryPagingMethodOneOf {
+interface PlatformQueryPagingMethodOneOf {
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
     /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -193,13 +192,13 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface PlatformPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface PlatformPaging {
     /**
      * Number of items to load.
      * @max 100
@@ -208,7 +207,7 @@ export interface PlatformPaging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -223,12 +222,12 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryCollectionsResponse {
+interface QueryCollectionsResponse {
     /** @maxSize 100 */
     collections?: Collection[];
     metadata?: PlatformPagingMetadata;
 }
-export interface PlatformPagingMetadata {
+interface PlatformPagingMetadata {
     /** The number of items returned in this response. */
     count?: number | null;
     /** The offset which was requested. Returned if offset paging was used. */
@@ -238,7 +237,7 @@ export interface PlatformPagingMetadata {
     /** Cursors to navigate through result pages. Returned if cursor paging was used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -250,14 +249,14 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface GetCollectionRequest {
+interface GetCollectionRequest {
     /** Requested collection ID. */
     _id: string;
 }
-export interface GetCollectionResponse {
+interface GetCollectionResponse {
     collection?: Collection;
 }
-export interface GetCollectionBySlugRequest {
+interface GetCollectionBySlugRequest {
     /**
      * Slug of the collection to retrieve.
      * @minLength 1
@@ -265,18 +264,10 @@ export interface GetCollectionBySlugRequest {
      */
     slug: string;
 }
-export interface GetCollectionBySlugResponse {
+interface GetCollectionBySlugResponse {
     /** The requested collection. */
     collection?: Collection;
 }
-type CollectionNonNullablePaths = `media.mainMedia.image.url` | `media.mainMedia.image.width` | `media.mainMedia.image.height` | `media.mainMedia.video.files` | `media.mainMedia.video.stillFrameMediaId` | `media.mainMedia.mediaType` | `media.mainMedia.title` | `media.mainMedia._id` | `media.items` | `numberOfProducts`;
-/**
- * Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
- * See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
- * @public
- * @fqn wix.catalog.api.v2.CollectionReadApi.QueryCollections
- */
-export declare function queryCollections(): CollectionsQueryBuilder;
 interface QueryOffsetResult {
     currentPage: number | undefined;
     totalPages: number | undefined;
@@ -286,13 +277,13 @@ interface QueryOffsetResult {
     length: number;
     pageSize: number;
 }
-export interface CollectionsQueryResult extends QueryOffsetResult {
+interface CollectionsQueryResult extends QueryOffsetResult {
     items: Collection[];
     query: CollectionsQueryBuilder;
     next: () => Promise<CollectionsQueryResult>;
     prev: () => Promise<CollectionsQueryResult>;
 }
-export interface CollectionsQueryBuilder {
+interface CollectionsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
      */
@@ -337,22 +328,5 @@ export interface CollectionsQueryBuilder {
     skip: (skip: number) => CollectionsQueryBuilder;
     find: () => Promise<CollectionsQueryResult>;
 }
-/**
- * Retrieves a collection with the provided ID.
- * @param _id - Requested collection ID.
- * @public
- * @requiredField _id
- * @fqn wix.catalog.api.v2.CollectionReadApi.GetCollection
- */
-export declare function getCollection(_id: string): Promise<NonNullablePaths<Collection, CollectionNonNullablePaths>>;
-/**
- * Retrieves a collection with the provided slug.
- * @param slug - Slug of the collection to retrieve.
- * @public
- * @requiredField slug
- * @fqn wix.catalog.api.v2.CollectionReadApi.GetCollectionBySlug
- */
-export declare function getCollectionBySlug(slug: string): Promise<NonNullablePaths<GetCollectionBySlugResponse, {
-    [P in CollectionNonNullablePaths]: `collection.${P}`;
-}[CollectionNonNullablePaths]>>;
-export {};
+export { type CollectionsQueryBuilder as C, type GetCollectionBySlugResponse as G, type Keyword as K, MediaItemType as M, type PlatformQuery as P, type QueryCollectionsRequest as Q, SortOrder as S, type Tag as T, type Collection as a, type Media as b, type MediaItem as c, type MediaItemItemOneOf as d, type MediaItemUrlAndSize as e, type MediaItemVideo as f, type SeoSchema as g, type Settings as h, type PlatformQueryPagingMethodOneOf as i, type Sorting as j, type PlatformPaging as k, type CursorPaging as l, type QueryCollectionsResponse as m, type PlatformPagingMetadata as n, type Cursors as o, type GetCollectionRequest as p, type GetCollectionResponse as q, type GetCollectionBySlugRequest as r, type CollectionsQueryResult as s };

package/build/{cjs/src/stores-catalog-v1-collection-collections.types.d.ts → meta.d.mts} RENAMED Viewed

@@ -1,4 +1,6 @@
-export interface Collection {
+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-DXVGSHC4.mjs';
+interface Collection {
     /**
      * Collection ID (generated automatically by the catalog).
      * @minLength 35
@@ -36,13 +38,13 @@ export interface Collection {
     /** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
     visible?: boolean | null;
 }
-export interface Media {
+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 {
+interface MediaItem extends MediaItemItemOneOf {
     /** Image data (URL, size). */
     image?: MediaItemUrlAndSize;
     /** Video data (URL, size). */
@@ -57,13 +59,13 @@ export interface MediaItem extends MediaItemItemOneOf {
     id?: string;
 }
 /** @oneof */
-export interface MediaItemItemOneOf {
+interface MediaItemItemOneOf {
     /** Image data (URL, size). */
     image?: MediaItemUrlAndSize;
     /** Video data (URL, size). */
     video?: MediaItemVideo;
 }
-export interface MediaItemUrlAndSize {
+interface MediaItemUrlAndSize {
     /**
      * Media item URL.
      * @format WEB_URL
@@ -78,7 +80,7 @@ export interface MediaItemUrlAndSize {
     /** Alt text. This text will be shown in case the image is not available. */
     altText?: string | null;
 }
-export declare enum MediaItemType {
+declare enum MediaItemType {
     unspecified_media_item_type = "unspecified_media_item_type",
     /** Image media type. */
     image = "image",
@@ -92,75 +94,17 @@ export declare enum MediaItemType {
     zip = "zip"
 }
 /** @enumType */
-export type MediaItemTypeWithLiterals = MediaItemType | 'unspecified_media_item_type' | 'image' | 'video' | 'audio' | 'document' | 'zip';
-export interface MediaItemVideo {
+type MediaItemTypeWithLiterals = MediaItemType | 'unspecified_media_item_type' | 'image' | 'video' | 'audio' | 'document' | 'zip';
+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;
 }
-/**
- * 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.
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
- * 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.
- */
-export interface SeoSchema {
-    /** SEO tag information. */
-    tags?: Tag[];
-    /** SEO general settings. */
-    settings?: Settings;
-}
-export interface Keyword {
-    /** Keyword value. */
-    term?: string;
-    /** Whether the keyword is the main focus keyword. */
-    isMain?: boolean;
-    /**
-     * The source that added the keyword terms to the SEO settings.
-     * @maxLength 1000
-     */
-    origin?: string | null;
-}
-export interface Tag {
-    /**
-     * SEO tag type.
-     *
-     *
-     * Supported values: `title`, `meta`, `script`, `link`.
-     */
-    type?: string;
-    /**
-     * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
-     * For example: `{"name": "description", "content": "the description itself"}`.
-     */
-    props?: Record<string, any> | null;
-    /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
-    meta?: Record<string, any> | null;
-    /** SEO tag inner content. For example, `<title> inner content </title>`. */
-    children?: string;
-    /** Whether the tag is a custom tag. */
-    custom?: boolean;
-    /** Whether the tag is disabled. */
-    disabled?: boolean;
-}
-export interface Settings {
-    /**
-     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
-     *
-     *
-     * Default: `false` (Auto Redirect is enabled.)
-     */
-    preventAutoRedirect?: boolean;
-    /**
-     * User-selected keyword terms for a specific page.
-     * @maxSize 5
-     */
-    keywords?: Keyword[];
-}
-export interface QueryCollectionsRequest {
+interface QueryCollectionsRequest {
     query?: PlatformQuery;
 }
-export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
+interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
     /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
@@ -171,13 +115,13 @@ export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
     sort?: Sorting[];
 }
 /** @oneof */
-export interface PlatformQueryPagingMethodOneOf {
+interface PlatformQueryPagingMethodOneOf {
     /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
     paging?: PlatformPaging;
     /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
     cursorPaging?: CursorPaging;
 }
-export interface Sorting {
+interface Sorting {
     /**
      * Name of the field to sort by.
      * @maxLength 512
@@ -186,13 +130,13 @@ export interface Sorting {
     /** Sort order. */
     order?: SortOrderWithLiterals;
 }
-export declare enum SortOrder {
+declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
 /** @enumType */
-export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-export interface PlatformPaging {
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface PlatformPaging {
     /**
      * Number of items to load.
      * @max 100
@@ -201,7 +145,7 @@ export interface PlatformPaging {
     /** Number of items to skip in the current sort order. */
     offset?: number | null;
 }
-export interface CursorPaging {
+interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
      * @max 100
@@ -216,12 +160,12 @@ export interface CursorPaging {
      */
     cursor?: string | null;
 }
-export interface QueryCollectionsResponse {
+interface QueryCollectionsResponse {
     /** @maxSize 100 */
     collections?: Collection[];
     metadata?: PlatformPagingMetadata;
 }
-export interface PlatformPagingMetadata {
+interface PlatformPagingMetadata {
     /** The number of items returned in this response. */
     count?: number | null;
     /** The offset which was requested. Returned if offset paging was used. */
@@ -231,7 +175,7 @@ export interface PlatformPagingMetadata {
     /** Cursors to navigate through result pages. Returned if cursor paging was used. */
     cursors?: Cursors;
 }
-export interface Cursors {
+interface Cursors {
     /**
      * Cursor string pointing to the next page in the list of results.
      * @maxLength 16000
@@ -243,14 +187,14 @@ export interface Cursors {
      */
     prev?: string | null;
 }
-export interface GetCollectionRequest {
+interface GetCollectionRequest {
     /** Requested collection ID. */
     id: string;
 }
-export interface GetCollectionResponse {
+interface GetCollectionResponse {
     collection?: Collection;
 }
-export interface GetCollectionBySlugRequest {
+interface GetCollectionBySlugRequest {
     /**
      * Slug of the collection to retrieve.
      * @minLength 1
@@ -258,7 +202,27 @@ export interface GetCollectionBySlugRequest {
      */
     slug: string;
 }
-export interface GetCollectionBySlugResponse {
+interface GetCollectionBySlugResponse {
     /** The requested collection. */
     collection?: Collection;
 }
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function queryCollections(): __PublicMethodMetaInfo<'GET', {}, QueryCollectionsRequest$1, QueryCollectionsRequest, QueryCollectionsResponse$1, QueryCollectionsResponse>;
+declare function getCollection(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetCollectionRequest$1, GetCollectionRequest, GetCollectionResponse$1, GetCollectionResponse>;
+declare function getCollectionBySlug(): __PublicMethodMetaInfo<'GET', {
+    slug: string;
+}, GetCollectionBySlugRequest$1, GetCollectionBySlugRequest, GetCollectionBySlugResponse$1, GetCollectionBySlugResponse>;
+export { type __PublicMethodMetaInfo, getCollection, getCollectionBySlug, queryCollections };