@wix/categories 1.0.20 → 1.0.21

package/build/es/src/categories-v1-category.universal.d.ts

@@ -1460,7 +1460,7 @@ export interface QueryCategoriesRequest {
      * A reference to the tree that contains this category.
      * Used only in the first request. Following requests use the cursor token.
      */
-    treeReference?: TreeReference;
+    treeReference: TreeReference;
     /**
      * Whether hidden categories should be included in the response. Default is `false`.
      * Used only in the first request. Following requests use the cursor token.
@@ -1538,22 +1538,6 @@ export interface Cursors {
     /** Cursor pointing to previous page in the list of results. */
     prev?: string | null;
 }
-export interface ListCompactCategoriesByIdsRequest {
-    /** List of category ids. */
-    categoryIds?: string[];
-    /** A reference to the tree that contains the categories. */
-    treeReference?: TreeReference;
-}
-export interface ListCompactCategoriesByIdsResponse {
-    /** Categories which satisfy the provided ids. */
-    categories?: CompactCategory[];
-}
-export interface CompactCategory {
-    /** Category ID. */
-    _id?: string | null;
-    /** Category name. */
-    name?: string | null;
-}
 export interface SearchCategoriesRequest {
     /** WQL query expression. */
     search?: CursorSearch;
@@ -2391,7 +2375,486 @@ export interface ActionEvent {
 }
 export interface Empty {
 }
-export interface CreateCategoryResponseNonNullableFields {
+export interface CreateCategoryResponseNonNullableFields {
+    category?: {
+        image: string;
+        numberOfItems: number;
+        breadcrumbs?: {
+            values: {
+                categoryId: string;
+                categoryName: string;
+                categorySlug: string;
+            }[];
+        };
+        richContentDescription?: {
+            nodes: {
+                buttonData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    type: Type;
+                    link?: {
+                        url: string;
+                        anchor: string;
+                        target: Target;
+                    };
+                };
+                codeBlockData?: {
+                    textStyle?: {
+                        textAlignment: TextAlignment;
+                    };
+                };
+                dividerData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    lineStyle: LineStyle;
+                    width: Width;
+                    alignment: Alignment;
+                };
+                fileData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    pdfSettings?: {
+                        viewMode: ViewMode;
+                    };
+                };
+                galleryData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    items: {
+                        image?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                    }[];
+                    options?: {
+                        layout?: {
+                            type: LayoutType;
+                            orientation: Orientation;
+                        };
+                        item?: {
+                            crop: Crop;
+                        };
+                        thumbnails?: {
+                            placement: ThumbnailsAlignment;
+                        };
+                    };
+                };
+                gifData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    height: number;
+                    width: number;
+                };
+                headingData?: {
+                    level: number;
+                    textStyle?: {
+                        textAlignment: TextAlignment;
+                    };
+                };
+                htmlData?: {
+                    url: string;
+                    html: string;
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    source: Source;
+                };
+                imageData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    link?: {
+                        url: string;
+                        anchor: string;
+                        target: Target;
+                    };
+                };
+                linkPreviewData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    link?: {
+                        url: string;
+                        anchor: string;
+                        target: Target;
+                    };
+                };
+                mapData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    mapSettings?: {
+                        mapType: MapType;
+                    };
+                };
+                paragraphData?: {
+                    textStyle?: {
+                        textAlignment: TextAlignment;
+                    };
+                };
+                pollData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    poll?: {
+                        options: Option[];
+                        settings?: {
+                            permissions?: {
+                                view: ViewRole;
+                                vote: VoteRole;
+                            };
+                        };
+                    };
+                    layout?: {
+                        poll?: {
+                            type: PollLayoutType;
+                            direction: PollLayoutDirection;
+                        };
+                    };
+                    design?: {
+                        poll?: {
+                            background?: {
+                                type: BackgroundType;
+                            };
+                        };
+                    };
+                };
+                textData?: {
+                    text: string;
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                appEmbedData?: {
+                    type: AppType;
+                };
+                videoData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                };
+                embedData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                };
+                collapsibleListData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    initialExpandedItems: InitialExpandedItems;
+                    direction: Direction;
+                };
+                tableData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                    dimensions?: {
+                        colsWidthRatio: number[];
+                        rowsHeight: number[];
+                        colsMinWidth: number[];
+                    };
+                };
+                tableCellData?: {
+                    cellStyle?: {
+                        verticalAlignment: VerticalAlignment;
+                    };
+                };
+                audioData?: {
+                    containerData?: {
+                        width?: {
+                            size: WidthType;
+                        };
+                        alignment: PluginContainerDataAlignment;
+                    };
+                };
+                orderedListData?: {
+                    indentation: number;
+                };
+                bulletedListData?: {
+                    indentation: number;
+                };
+                blockquoteData?: {
+                    indentation: number;
+                };
+                type: NodeType;
+                _id: string;
+                nodes: NonNullable<NonNullable<NonNullable<CreateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
+            }[];
+            metadata?: {
+                version: number;
+            };
+            documentStyle?: {
+                headerOne?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                headerTwo?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                headerThree?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                headerFour?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                headerFive?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                headerSix?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                paragraph?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                blockquote?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+                codeBlock?: {
+                    decorations: {
+                        anchorData?: {
+                            anchor: string;
+                        };
+                        linkData?: {
+                            link?: {
+                                url: string;
+                                anchor: string;
+                                target: Target;
+                            };
+                        };
+                        mentionData?: {
+                            name: string;
+                            slug: string;
+                        };
+                        fontSizeData?: {
+                            unit: FontType;
+                        };
+                        type: DecorationType;
+                    }[];
+                };
+            };
+        };
+    };
+}
+export interface GetCategoryResponseNonNullableFields {
     category?: {
         image: string;
         numberOfItems: number;
@@ -2662,7 +3125,7 @@ export interface CreateCategoryResponseNonNullableFields {
                 };
                 type: NodeType;
                 _id: string;
-                nodes: NonNullable<NonNullable<NonNullable<CreateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
+                nodes: NonNullable<NonNullable<NonNullable<GetCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
             }[];
             metadata?: {
                 version: number;
@@ -2870,7 +3333,7 @@ export interface CreateCategoryResponseNonNullableFields {
         };
     };
 }
-export interface GetCategoryResponseNonNullableFields {
+export interface UpdateCategoryResponseNonNullableFields {
     category?: {
         image: string;
         numberOfItems: number;
@@ -3141,7 +3604,7 @@ export interface GetCategoryResponseNonNullableFields {
                 };
                 type: NodeType;
                 _id: string;
-                nodes: NonNullable<NonNullable<NonNullable<GetCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
+                nodes: NonNullable<NonNullable<NonNullable<UpdateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
             }[];
             metadata?: {
                 version: number;
@@ -3349,8 +3812,8 @@ export interface GetCategoryResponseNonNullableFields {
         };
     };
 }
-export interface UpdateCategoryResponseNonNullableFields {
-    category?: {
+export interface QueryCategoriesResponseNonNullableFields {
+    categories: {
         image: string;
         numberOfItems: number;
         breadcrumbs?: {
@@ -3620,7 +4083,7 @@ export interface UpdateCategoryResponseNonNullableFields {
                 };
                 type: NodeType;
                 _id: string;
-                nodes: NonNullable<NonNullable<NonNullable<UpdateCategoryResponseNonNullableFields>['category']>['richContentDescription']>['nodes'][];
+                nodes: NonNullable<NonNullable<NonNullable<QueryCategoriesResponseNonNullableFields>['categories'][0]>['richContentDescription']>['nodes'][];
             }[];
             metadata?: {
                 version: number;
@@ -3826,7 +4289,7 @@ export interface UpdateCategoryResponseNonNullableFields {
                 };
             };
         };
-    };
+    }[];
 }
 export interface SearchCategoriesResponseNonNullableFields {
     categories: {
@@ -5596,6 +6059,105 @@ export interface UpdateCategoryOptions {
  * @requiredField treeReference.appNamespace
  */
 export declare function deleteCategory(categoryId: string, treeReference: TreeReference): Promise<void>;
+/**
+ * Query Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+ * @public
+ * @documentationMaturity preview
+ * @applicableIdentity MEMBER
+ * @applicableIdentity VISITOR
+ */
+export declare function queryCategories(options: QueryCategoriesOptions): CategoriesQueryBuilder;
+export interface QueryCategoriesOptions {
+    /**
+     * A reference to the tree that contains this category.
+     * Used only in the first request. Following requests use the cursor token.
+     */
+    treeReference: TreeReference;
+    /**
+     * Whether hidden categories should be included in the response. Default is `false`.
+     * Used only in the first request. Following requests use the cursor token.
+     */
+    includeHidden?: boolean | undefined;
+    /** Fields to return in the response. When not provided, these fields are not returned. */
+    fields?: RequestedFields[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+export interface CategoriesQueryResult extends QueryCursorResult {
+    items: Category[];
+    query: CategoriesQueryBuilder;
+    next: () => Promise<CategoriesQueryResult>;
+    prev: () => Promise<CategoriesQueryResult>;
+}
+export interface CategoriesQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id' | 'name' | 'description' | 'slug', value: string) => CategoriesQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any[]) => CategoriesQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: any) => CategoriesQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'name' | 'description' | 'slug', value: boolean) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => CategoriesQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'name' | 'slug'>) => CategoriesQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => CategoriesQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => CategoriesQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<CategoriesQueryResult>;
+}
 /**
  * Search Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
  * @public
@@ -5901,3 +6463,4 @@ export interface SetArrangedItemsOptions {
  * @applicableIdentity VISITOR
  */
 export declare function getArrangedItems(categoryId: string, treeReference: TreeReference): Promise<GetArrangedItemsResponse & GetArrangedItemsResponseNonNullableFields>;
+export {};